sites

Consultar um site

O endereço, o plano, a revisão de rascunho e a versão publicada do site. Um site de outro workspace retorna 404.

GET/v1/sites/{site_id}

Request

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

import json
import requests

url = "https://api.atelier201.com/v1/sites/<site_id>"
headers = {
  "Authorization": "<api-key>"
}

response = requests.request("GET", url, headers=headers)
print(response.json())

const response = await fetch("https://api.atelier201.com/v1/sites/<site_id>", {
  method: "GET",
  headers: {
    "Authorization": "<api-key>"
  },
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://api.atelier201.com/v1/sites/<site_id>");
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/<site_id>", 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/<site_id>"))
    .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/<site_id>")
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.

Envie generation como expected_generation ao publicar, reverter ou despublicar. Um site de outro workspace retorna 404, assim como um site inexistente.

Autorizações

Authorizationbearerin headerrequired

Parâmetros de caminho

site_idstringrequired

O id do site ou seu slug (o endereço antes de .atelier201.page).

Resposta

application/json

Recuperar um site

dataobjectrequired

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>" }

Consultar um site

Autorizações

Parâmetros de caminho

Resposta

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies