builds

Eine erstellte Seite abrufen

Eine Seite eines Builds, wie Besucher sie lesen würden, für einen Agenten ohne Browser: Titel, Beschreibung, Überschriften, Links, sichtbarer Text und issues, die bei einer kurzen Prüfung auffallen würden (kein h1, Bilder ohne alt, Platzhaltertext). Standard: die Startseite des neuesten fertigen Builds des Entwurfs. Mit einem Browser liefert getSiteBuild mit preview=true stattdessen einen Link, über den du die Seite ansehen kannst.

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

Erfordert sites:read. Ändert nichts.

Gibt den Titel, die Beschreibung, Überschriften, Links und sichtbaren Text der Seite zurück, außerdem die anderen pages des Builds sowie issues, die bei einer kurzen Prüfung auffallen würden: kein <title> oder h1, mehrere h1, Bilder ohne alt, Links ohne Text oder Platzhaltertext. Standardmäßig wird / aus dem neuesten fertigen Build des Entwurfs zurückgegeben.

Wenn ein Browser verfügbar ist, liefert Build abrufen mit preview=true stattdessen einen privaten Link, über den sich die Seite ansehen lässt.

Autorisierung

Authorizationbearerin headerrequired

Pfadparameter

site_idstringrequired

ID der Website oder ihr Slug (die Adresse vor .atelier201.page).

Query-Parameter

pathstringlength: ≤ 600 chars

Die Seite, wie ein Besucher sie eingeben würde: / oder /about. Standardwert: /.

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

Ein Build. Standard: der neueste fertige Build des Entwurfs (das, was eine Vorschau anzeigt).

Antwort

application/json

Eine erstellte Seite lesen

dataobjectrequired

Show child attributes

data.build_idstringrequired

data.revisionstringrequiredlength: 40–40 chars

Eine Git-Commit-ID (40 hexadezimale Zeichen) des Repositorys der Website.

data.pathstringrequired

data.statusintegerrequiredrange: -9007199254740991–9007199254740991

200, 404 (die Fehlerseite der Website, falls vorhanden) oder der Status einer Weiterleitung.

data.locationstring

Das Ziel einer Weiterleitung.

data.pagesstring[]required

Alle Seiten des Builds, um die übrigen Seiten zu lesen.

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

Das Bild, das beim Teilen eines Links zur Seite angezeigt wird (og:image), oder null.

data.structured_datastring[]

Die schema.org-Typen, die die Seite in JSON-LD angibt (LocalBusiness, Article...).

data.broken_targetsstring[]

Interne Links und Dateien (Bilder, Stylesheets, Skripte), die auf der Seite verwendet werden, aber im Build fehlen.

data.textstring

Der sichtbare Text des Hauptinhalts der Seite, höchstens 20,000 Zeichen.

data.text_truncatedboolean

data.issuesstring[]

Was bei einer kurzen Prüfung auffallen würde: kein Titel oder h1, mehrere h1, Bilder ohne alt, Links ohne Text, Platzhaltertext.

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

Eine erstellte Seite abrufen

Autorisierung

Pfadparameter

Query-Parameter

Antwort

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies