sites

Executar um comando no workspace

Um comando bash na raiz do projeto, em uma cópia de trabalho do rascunho no próprio contêiner do site: rg, grep, sed, find, cat, node. Uma compilação do projeto é recusada (400): workspace:commit envia os arquivos pelas mesmas verificações de qualquer alteração e inicia a compilação real, cujos erros são informados por getSiteBuild. Sem rede, por no máximo 300 s. Os arquivos alterados permanecem sem commit (listados em uncommitted) até workspace:commit. O workspace acompanha o rascunho: outra alteração mantém as suas edições sem commit.

POST/v1/sites/{site_id}/workspace:run

Request

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

import json
import requests

url = "https://api.atelier201.com/v1/sites/<site_id>/workspace:run"
headers = {
  "Authorization": "<api-key>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"command\":\"<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>/workspace:run", {
  method: "POST",
  headers: {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "command": "<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>/workspace:run");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: <api-key>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{\"command\":\"<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>/workspace:run", bytes.NewBuffer([]byte("{\"command\":\"<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>/workspace:run"))
    .header("Authorization", "<api-key>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"command\":\"<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>/workspace:run")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "<api-key>"
request["Content-Type"] = "application/json"
request.body = "{\"command\":\"<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": {
    "revision": "<string>",
    "exit_code": 123,
    "timed_out": true,
    "output": "<string>",
    "truncated": true,
    "uncommitted": [
      "<string>"
    ],
    "note": null
  },
  "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:write. Não custa créditos. O caminho termina em /workspace:run.

O workspace é um shell em uma cópia de trabalho do rascunho do site, dentro do próprio contêiner do site e sem conexão com a internet. Use-o para tarefas que um shell executa bem: rg, grep, find, cat, sed -i, node e npx astro build para testar uma compilação em segundos. O comando é executado na raiz do projeto como um usuário sem privilégios, e não há acesso à rede.

As alterações feitas pelo comando permanecem sem commit. A resposta lista essas alterações em uncommitted, uma por linha, no estilo de git status (M src/pages/index.astro). Nada é adicionado ao histórico até você fazer commit do workspace, e os visitantes não veem nada até você publicar.

command pode ter no máximo 8000 caracteres. timeout_ms deve estar entre 1000 e 300000 e, por padrão, é 60000: se o comando ainda estiver em execução nesse momento, ele será interrompido e timed_out será true. Uma falha no comando não é um erro da API: a chamada é bem-sucedida e exit_code não é 0. output reúne stdout e stderr; acima de 8 KB, mantém o início e o fim, e truncated será true.

O workspace acompanha o rascunho. Se outra alteração tiver modificado o rascunho desde seu último comando, suas edições sem commit serão preservadas e note informará isso. O mesmo vale quando o workspace precisa ser recriado.

Um site que ainda está sendo criado responde com result_not_ready; um site suspenso ou em processo de exclusão responde com conflict.

Autorizações

Authorizationbearerin headerrequired

Parâmetros de caminho

site_idstringrequired

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

Corpo

application/jsonrequired

commandstringrequiredlength: 1–8000 chars

Um comando bash executado na raiz do projeto, em uma cópia de trabalho do rascunho: rg, grep, sed, find, cat, node... Sem rede. Os arquivos alterados permanecem sem commit até workspace:commit, que os compila e informa qualquer erro de compilação. A compilação do projeto é recusada aqui: levou 30 s e duplicou essa compilação.

timeout_msintegerrange: 1000–300000

Padrão: 60000. O comando é interrompido ao ultrapassar esse limite.

Resposta

application/json

Execute um comando shell no workspace do site

dataobjectrequired

Show child attributes

data.revisionstringrequiredlength: 40–40 chars

A revisão do rascunho a partir da qual o workspace foi iniciado.

data.exit_codeintegerrequiredrange: -9007199254740991–9007199254740991

data.timed_outbooleanrequired

data.outputstringrequired

stdout e stderr juntos; acima de 8 KB, mostra o início e o fim.

data.truncatedbooleanrequired

data.uncommittedstring[]required

As alterações sem commit do workspace após o comando, no estilo de git status ("M src/pages/index.astro").

data.notestringnullrequired

Informado quando o workspace foi recriado ou atualizado para um rascunho mais recente antes do comando.

request_idstringrequired

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

{ "data": { "revision": "<string>", "exit_code": 123, "timed_out": true, "output": "<string>", "truncated": true, "uncommitted": [ "<string>" ], "note": null }, "request_id": "<string>" }

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

Executar um comando no workspace

Autorizações

Parâmetros de caminho

Corpo

Resposta

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies