builds

Ler uma página compilada

Uma página de um build, como um visitante a veria, para um agente sem navegador: título, descrição, títulos, links, texto visível e issues que uma revisão rápida identificaria (ausência de h1, imagens sem alt, texto de placeholder). Padrão: a página inicial do build pronto mais recente do rascunho. Se houver um navegador, getSiteBuild com preview=true fornece um link para visualizá-la.

GET/v1/sites/{site_id}/pages

Request

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

import json
import requests

url = "https://api.atelier201.com/v1/sites/<site_id>/pages"
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>/pages", {
  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>/pages");
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>/pages", 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>/pages"))
    .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>/pages")
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": {
    "build_id": "<string>",
    "revision": "<string>",
    "path": "<string>",
    "status": 123,
    "location": "<string>",
    "pages": [
      "<string>"
    ],
    "title": null,
    "description": null,
    "lang": null,
    "headings": [
      {
        "level": 123,
        "text": "<string>"
      }
    ],
    "links": [
      {
        "href": "<string>",
        "text": "<string>"
      }
    ],
    "images_without_alt": [
      "<string>"
    ],
    "og_image": null,
    "structured_data": [
      "<string>"
    ],
    "broken_targets": [
      "<string>"
    ],
    "text": "<string>",
    "text_truncated": true,
    "issues": [
      "<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 altera nada.

Retorna o título, a descrição, os cabeçalhos, os links e o texto visível da página, as outras pages do build e os issues que uma revisão rápida identificaria: ausência de <title> ou h1, vários h1, imagens sem alt, links sem texto e texto provisório. Padrão: / do build pronto mais recente do rascunho.

Se houver um navegador, Recuperar um build com preview=true retorna um link privado para visualizar a página.

Autorizações

Authorizationbearerin headerrequired

Parâmetros de caminho

site_idstringrequired

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

Parâmetros de consulta

pathstringlength: ≤ 600 chars

A página como um visitante a digitaria: / ou /about. Padrão: /.

build_idstring<uuid>pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Um build. Padrão: o build pronto mais recente do rascunho (o que uma prévia exibe).

Resposta

application/json

Ler uma página gerada

dataobjectrequired

Show child attributes

data.build_idstringrequired

data.revisionstringrequiredlength: 40–40 chars

Um ID de commit do Git (40 caracteres hexadecimais) do repositório do site.

data.pathstringrequired

data.statusintegerrequiredrange: -9007199254740991–9007199254740991

200, 404 (a página de não encontrado do site, se houver) ou o status do redirecionamento.

data.locationstring

Para onde um redirecionamento leva.

data.pagesstring[]required

Todas as páginas do build, para ler as demais.

data.titlestringnull

data.descriptionstringnull

data.langstringnull

data.headingsobject[]

Show child attributes

data.headings.levelintegerrequiredrange: -9007199254740991–9007199254740991

data.headings.textstringrequired

data.linksobject[]

Show child attributes

data.links.hrefstringrequired

data.links.textstringrequired

data.images_without_altstring[]

data.og_imagestringnull

A imagem exibida ao compartilhar um link para a página (og:image), ou null.

data.structured_datastring[]

Os tipos schema.org declarados pela página em JSON-LD (LocalBusiness, Article...).

data.broken_targetsstring[]

Links internos e arquivos (imagens, estilos, scripts) usados pela página que não estão disponíveis no build.

data.textstring

O texto visível do conteúdo principal da página, com no máximo 20,000 caracteres.

data.text_truncatedboolean

data.issuesstring[]

O que uma revisão rápida identificaria: ausência de title ou h1, vários h1, imagens sem alt, links sem texto, texto de placeholder.

request_idstringrequired

{ "data": { "build_id": "<string>", "revision": "<string>", "path": "<string>", "status": 123, "location": "<string>", "pages": [ "<string>" ], "title": null, "description": null, "lang": null, "headings": [ { "level": 123, "text": "<string>" } ], "links": [ { "href": "<string>", "text": "<string>" } ], "images_without_alt": [ "<string>" ], "og_image": null, "structured_data": [ "<string>" ], "broken_targets": [ "<string>" ], "text": "<string>", "text_truncated": true, "issues": [ "<string>" ] }, "request_id": "<string>" }

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

Ler uma página compilada

Autorizações

Parâmetros de caminho

Parâmetros de consulta

Resposta

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies