sites

Listar sites

Todos os sites do workspace, do mais recente ao mais antigo, com endereço, plano, revisão do rascunho e informações sobre o que está publicado.

GET/v1/sites

Request

curl --request GET \
  --url 'https://api.atelier201.com/v1/sites' \
  --header 'Authorization: <api-key>'

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://api.atelier201.com/v1/sites");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: <api-key>",
]);
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://api.atelier201.com/v1/sites", nil)
  req.Header.Set("Authorization", "<api-key>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://api.atelier201.com/v1/sites"))
    .header("Authorization", "<api-key>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://api.atelier201.com/v1/sites")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "<api-key>"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "slug": "<string>",
      "status": "creating",
      "plan": "free",
      "url": "<string>",
      "platform_url": "<string>",
      "guest": true,
      "draft": {
        "revision": "<string>",
        "updated_at": "<string>"
      },
      "published": {
        "build_id": "<string>",
        "generation": 123,
        "published_at": "<string>"
      },
      "generation": 123,
      "cover_at": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

Requer sites:read. Não consome créditos.

Comece aqui para obter um site_id. O valor de published de um site é null até a primeira publicação, e guest é true para um site preparado por um agente que ainda não foi reivindicado por ninguém.

Autorizações

Authorizationbearerin headerrequired

Resposta

application/json

Listar sites

dataobject[]required

Show child attributes

data.idstringrequired

data.namestringrequired

data.slugstringrequired

data.statusenum<string>requiredone of: creating, ready, suspended, deleting

data.planenum<string>requiredone of: free, site

data.urlstringrequired

Onde os visitantes encontram o site: no domínio personalizado principal ou no endereço atelier201.page.

data.platform_urlstringrequired

data.guestbooleanrequired

Preparado por um agente antes do login e ainda não reivindicado: pode ser visualizado, mas não publicado.

data.draftobjectrequired

Show child attributes

data.draft.revisionstring | nullrequired

data.draft.updated_atstring | nullrequired

data.publishedobject | nullrequired

Show child attributes

data.published.build_idstringrequired

data.published.generationintegerrequiredrange: -9007199254740991–9007199254740991

data.published.published_atstring | nullrequired

data.generationintegerrequiredrange: -9007199254740991–9007199254740991

Aumenta a cada publicação, reversão ou retirada de publicação. Envie esse valor de volta como expected_generation.

data.cover_atstring | nullrequired

Quando foi feita, após uma compilação do site, a captura da página inicial exibida pelo app no cartão do site. Nulo antes da primeira captura.

data.created_atstringrequired

ISO 8601, UTC.

data.updated_atstringrequired

ISO 8601, UTC.

request_idstringrequired

{ "data": [ { "id": "<string>", "name": "<string>", "slug": "<string>", "status": "creating", "plan": "free", "url": "<string>", "platform_url": "<string>", "guest": true, "draft": { "revision": "<string>", "updated_at": "<string>" }, "published": { "build_id": "<string>", "generation": 123, "published_at": "<string>" }, "generation": 123, "cover_at": "<string>", "created_at": "<string>", "updated_at": "<string>" } ], "request_id": "<string>" }

{ "error": { "type": "<string>", "code": "<string>", "message": "<string>", "param": "<string>", "docs_url": "<string>", "action_url": "<string>", "details": {} }, "request_id": "<string>" }

Listar sites

Autorizações

Resposta

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies