builds

Build a site

Compiles the draft (or revision) into a static site, in an isolated container with no network. Returns at once with build (its id, state queued), reused and is_requested_revision; then getSiteBuild with wait=50 answers when it is ready or failed (usually under a minute). A ready build of the same revision is reused instead of building twice. One build runs at a time per site: when an earlier version is running, the answer is that build with is_requested_revision: false; wait for it, then call again.

POST/v1/sites/{site_id}/builds

Request

curl --request POST \
  --url 'https://api.atelier201.com/v1/sites/<site_id>/builds' \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "revision": "<string>"
}'

import json
import requests

url = "https://api.atelier201.com/v1/sites/<site_id>/builds"
headers = {
  "Authorization": "<api-key>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"revision\":\"<string>\"}")

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

const response = await fetch("https://api.atelier201.com/v1/sites/<site_id>/builds", {
  method: "POST",
  headers: {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "revision": "<string>"
  }),
});

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>/builds");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: <api-key>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{\"revision\":\"<string>\"}");
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

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

package main

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

func main() {
  req, _ := http.NewRequest("POST", "https://api.atelier201.com/v1/sites/<site_id>/builds", bytes.NewBuffer([]byte("{\"revision\":\"<string>\"}")))
  req.Header.Set("Authorization", "<api-key>")
  req.Header.Set("Content-Type", "application/json")
  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>/builds"))
    .header("Authorization", "<api-key>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"revision\":\"<string>\"}"))
    .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>/builds")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "<api-key>"
request["Content-Type"] = "application/json"
request.body = "{\"revision\":\"<string>\"}"

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>",
      "site_id": "<string>",
      "revision": "<string>",
      "state": "queued",
      "target_origin": "<string>",
      "profile": "standard",
      "file_count": 123,
      "total_bytes": 123,
      "duration_ms": 123,
      "error": {
        "code": "<string>",
        "message": null
      },
      "warnings": [
        "<string>"
      ],
      "created_at": "<string>",
      "started_at": "<string>",
      "finished_at": "<string>"
    },
    "reused": true,
    "is_requested_revision": true,
    "note": "<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:write. Costs no credits.

It answers 202 at once with a build in queued. Poll Retrieve a build every few seconds until it is ready or failed. A ready build of the same revision is reused, and reused says so.

When a build fails, error says why and the log shows the compiler’s output. Fix the files and build again.

Authorizations

Authorizationbearerin headerrequired

Path parameters

site_idstringrequired

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

Body

application/jsonrequired

revisionstringlength: 40–40 chars

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

Response

application/json

Build a site

dataobjectrequired

Show child attributes

data.buildobjectrequired

Show child attributes

data.build.idstringrequired

data.build.site_idstringrequired

data.build.revisionstringrequiredlength: 40–40 chars

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

data.build.stateenum<string>requiredone of: queued, building, collecting, ready, failed, cancelled

data.build.target_originstringrequired

data.build.profileenum<string>requiredone of: standard, guest-demo

data.build.file_countinteger | nullrequired

data.build.total_bytesinteger | nullrequired

data.build.duration_msinteger | nullrequired

data.build.errorobject | nullrequired

Show child attributes

data.build.error.codestringrequired

data.build.error.messagestringnullrequired

data.build.warningsstring[]required

data.build.created_atstringrequired

ISO 8601, UTC.

data.build.started_atstring | nullrequired

data.build.finished_atstring | nullrequired

data.reusedbooleanrequired

data.is_requested_revisionbooleanrequired

False when build is an earlier version already running (one build at a time per site): wait for it to finish, whatever its outcome, then start again to get the build of the revision you asked for.

data.notestring

What to do next, present when is_requested_revision is false.

request_idstringrequired

curl --request POST \ --url 'https://api.atelier201.com/v1/sites/<site_id>/builds' \ --header 'Authorization: <api-key>' \ --header 'Content-Type: application/json' \ --data '{ "revision": "<string>" }'

{ "data": { "build": { "id": "<string>", "site_id": "<string>", "revision": "<string>", "state": "queued", "target_origin": "<string>", "profile": "standard", "file_count": 123, "total_bytes": 123, "duration_ms": 123, "error": { "code": "<string>", "message": null }, "warnings": [ "<string>" ], "created_at": "<string>", "started_at": "<string>", "finished_at": "<string>" }, "reused": true, "is_requested_revision": true, "note": "<string>" }, "request_id": "<string>" }

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

Build a site

Authorizations

Path parameters

Body

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies