sites

Ejecutar un comando en el espacio de trabajo

Un comando de bash en la raíz del proyecto, sobre una copia de trabajo del borrador dentro del propio contenedor del sitio: rg, grep, sed, find, cat, node. Se rechaza la compilación del proyecto (400): workspace:commit somete los archivos a las mismas comprobaciones que cualquier cambio e inicia la compilación real, cuyos errores comunica getSiteBuild. Sin acceso a la red, máximo 300 s. Los archivos que modifica quedan sin confirmar (se muestran en uncommitted) hasta ejecutar workspace:commit. El espacio de trabajo sigue el borrador: cualquier otro cambio conserva tus ediciones sin confirmar.

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

Requiere sites:write. No consume créditos. La ruta termina en /workspace:run.

El espacio de trabajo es un shell en una copia de trabajo del borrador del sitio, dentro del contenedor propio del sitio y sin conexión. Úsalo para las tareas en las que un shell funciona bien: rg, grep, find, cat, sed -i, node y npx astro build para probar una compilación en segundos. El comando se ejecuta en la raíz del proyecto como usuario sin privilegios, y no hay conexión de red.

Los cambios que realiza el comando quedan sin confirmar. La respuesta enumera esos cambios en uncommitted, uno por línea, con el formato de git status (M src/pages/index.astro). No se incorporan al historial hasta que confirmes los cambios del espacio de trabajo, y los visitantes no verán nada hasta que publiques.

command puede tener un máximo de 8000 caracteres. timeout_ms debe estar entre 1000 y 300000, y su valor predeterminado es 60000: si el comando sigue ejecutándose al llegar a ese límite, se detiene y timed_out es true. Si un comando falla, no se considera un error de API: la llamada se completa correctamente y exit_code no es 0. output contiene stdout y stderr juntos; si supera los 8 KB, conserva el principio y el final, y truncated es true.

El espacio de trabajo sigue al borrador. Si otro cambio ha modificado el borrador desde tu último comando, se conservan tus cambios sin confirmar y note lo indica. Ocurre lo mismo si ha sido necesario reconstruir el espacio de trabajo.

Un sitio que todavía se está creando responde con result_not_ready; un sitio suspendido o en proceso de eliminación responde con conflict.

Autorizaciones

Authorizationbearerin headerrequired

Parámetros de ruta

site_idstringrequired

El ID del sitio o su slug (la dirección antes de .atelier201.page).

Cuerpo

application/jsonrequired

commandstringrequiredlength: 1–8000 chars

Un comando de bash, ejecutado en la raíz del proyecto sobre una copia de trabajo del borrador: rg, grep, sed, find, cat, node... Sin acceso a la red. Los archivos que modifica quedan sin confirmar hasta ejecutar workspace:commit, que los compila y comunica cualquier error de compilación. Aquí se rechaza la compilación del proyecto: tardaba 30 s y duplicaba esa compilación.

timeout_msintegerrange: 1000–300000

Valor predeterminado: 60000. El comando se detiene al superar este límite.

Respuesta

application/json

Ejecuta un comando de shell en el espacio de trabajo del sitio

dataobjectrequired

Show child attributes

data.revisionstringrequiredlength: 40–40 chars

La revisión del borrador desde la que se inició el espacio de trabajo.

data.exit_codeintegerrequiredrange: -9007199254740991–9007199254740991

data.timed_outbooleanrequired

data.outputstringrequired

stdout y stderr juntos; si supera 8 KB, se muestran el principio y el final.

data.truncatedbooleanrequired

data.uncommittedstring[]required

Los cambios del espacio de trabajo que siguen sin confirmar después del comando, con el formato de git status ("M src/pages/index.astro").

data.notestringnullrequired

Se indica si el espacio de trabajo se reconstruyó o se actualizó a un borrador más reciente antes de ejecutar el 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>" }

Ejecutar un comando en el espacio de trabajo

Autorizaciones

Parámetros de ruta

Cuerpo

Respuesta

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies