builds

Read a built page

One page of a build as a visitor would read it, for an agent with no browser: title, description, headings, links, the visible text, and issues a quick review would catch (no h1, images without alt, placeholder text). Default: the home page of the newest ready build of the draft. With a browser, getSiteBuild with preview=true gives a link to look at it instead.

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

Requires sites:read. Changes nothing.

Returns the page’s title, description, headings, links and visible text, the other pages of the build, and issues a quick review would catch: no <title> or h1, several h1, images without alt, links without text, placeholder text. Default: / of the newest ready build of the draft.

With a browser, Retrieve a build with preview=true returns a private link to look at the page instead.

Authorizations

Authorizationbearerin headerrequired

Path parameters

site_idstringrequired

The site's id, or its slug (the address before .atelier201.page).

Query parameters

pathstringlength: ≤ 600 chars

The page, as a visitor would type it: / or /about. Default /.

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)$

A build. Default: the newest ready build of the draft (what a preview shows).

Response

application/json

Read a built page

dataobjectrequired

Show child attributes

data.build_idstringrequired

data.revisionstringrequiredlength: 40–40 chars

A Git commit id (40 hex characters) of the site's repository.

data.pathstringrequired

data.statusintegerrequiredrange: -9007199254740991–9007199254740991

200, 404 (the site's not-found page, when it has one) or a redirect's status.

data.locationstring

Where a redirect goes.

data.pagesstring[]required

Every page of the build, to read the others.

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

The picture a shared link to the page shows (og:image), or null.

data.structured_datastring[]

The schema.org types the page declares in JSON-LD (LocalBusiness, Article...).

data.broken_targetsstring[]

Internal links and files (images, styles, scripts) the page uses that the build does not have.

data.textstring

The visible text of the page's main content, at most 20,000 characters.

data.text_truncatedboolean

data.issuesstring[]

What a quick review would catch: no title or h1, several h1, images without alt, links without text, placeholder text.

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

Read a built page

Authorizations

Path parameters

Query parameters

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies