builds

Récupérer une compilation

État d’un build ; error explique un échec et getSiteBuildLog affiche la sortie du compilateur. wait (jusqu’à 50 secondes) renvoie une réponse dès que le build est terminé, au lieu d’interroger son état à répétition. preview=true ajoute preview_url à un build prêt : un lien privé à ouvrir dans un navigateur pour vérifier les pages.

GET/v1/sites/{site_id}/builds/{build_id}

Request

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

import json
import requests

url = "https://api.atelier201.com/v1/sites/<site_id>/builds/<build_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>/builds/<build_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>/builds/<build_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>/builds/<build_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>/builds/<build_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>/builds/<build_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>",
    "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>",
    "preview_url": "<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>"
}

Nécessite sites:read.

ready, failed et cancelled sont des états définitifs. Plutôt que d’interroger le statut à répétition, transmettez wait (jusqu’à 50 secondes) : la réponse est renvoyée dès que la compilation est terminée. preview=true ajoute preview_url à une compilation prête : un lien privé valable un jour, à ouvrir dans un navigateur (il faut sites:write, car le lien est créé). warnings répertorie les messages non bloquants de la compilation.

Autorisations

Authorizationbearerin headerrequired

Paramètres de chemin

site_idstringrequired

L’identifiant du site ou son slug (l’adresse avant .atelier201.page).

build_idstringrequired

Paramètres de requête

waitintegerrange: 0–50

Nombre de secondes à attendre la fin du build (prêt, échoué ou annulé) avant de répondre. 0 ou omis : réponse immédiate.

previewboolean

Quand le build est prêt, renvoie aussi preview_url : un lien privé vers le build (valable un jour et réutilisé pendant cette période), à ouvrir dans un navigateur pour vérifier les pages.

Réponse

application/json

Récupérer un build

dataobjectrequired

Show child attributes

data.idstringrequired

data.site_idstringrequired

data.revisionstringrequiredlength: 40–40 chars

Un identifiant de commit Git (40 caractères hexadécimaux) du dépôt du site.

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

data.target_originstringrequired

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

data.file_countinteger | nullrequired

data.total_bytesinteger | nullrequired

data.duration_msinteger | nullrequired

data.errorobject | nullrequired

Show child attributes

data.error.codestringrequired

data.error.messagestringnullrequired

data.warningsstring[]required

data.created_atstringrequired

ISO 8601, UTC.

data.started_atstring | nullrequired

data.finished_atstring | nullrequired

data.preview_urlstring

Avec preview=true sur un build prêt : lien privé à ouvrir dans un navigateur.

request_idstringrequired

{ "data": { "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>", "preview_url": "<string>" }, "request_id": "<string>" }

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

Récupérer une compilation

Autorisations

Paramètres de chemin

Paramètres de requête

Réponse

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies