builds

Recuperar um build

O estado de um build; error explica uma falha, e getSiteBuildLog mostra a saída do compilador. wait (até 50 segundos) responde assim que o build termina, em vez de consultar o estado repetidamente; preview=true adiciona preview_url a um build pronto, um link privado para abrir no navegador e conferir as páginas.

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

Requer sites:read.

ready, failed e cancelled são estados finais. Em vez de consultar repetidamente, passe wait (até 50 segundos): a resposta chega assim que o build termina. preview=true adiciona preview_url a um build pronto, um link privado válido por um dia que pode ser aberto em um navegador (requer sites:write, pois cria o link). warnings lista as mensagens não fatais do build.

Autorizações

Authorizationbearerin headerrequired

Parâmetros de caminho

site_idstringrequired

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

build_idstringrequired

Parâmetros de consulta

waitintegerrange: 0–50

Segundos de espera para o build terminar (pronto, com falha ou cancelado) antes de responder. 0 ou omitido: responder imediatamente.

previewboolean

Quando o build estiver pronto, também retorna preview_url: um link privado para acessá-lo (válido por um dia, reutilizado enquanto estiver válido) e abrir no navegador para conferir as páginas.

Resposta

application/json

Recuperar um build

dataobjectrequired

Show child attributes

data.idstringrequired

data.site_idstringrequired

data.revisionstringrequiredlength: 40–40 chars

Um ID de commit do Git (40 caracteres hexadecimais) do repositório do 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

Com preview=true em um build pronto: um link privado para abrir no navegador.

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

Recuperar um build

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