sites

Eseguire un comando nell'area di lavoro

Un comando bash nella directory principale del progetto, su una copia di lavoro della bozza nel container del sito: rg, grep, sed, find, cat, node. La build del progetto viene rifiutata (400): workspace:commit invia i file agli stessi controlli previsti per ogni modifica e avvia la build effettiva, i cui errori vengono segnalati da getSiteBuild. Nessuna rete, massimo 300 s. I file modificati restano non sottoposti a commit (elencati in uncommitted) fino a workspace:commit. L'area di lavoro segue la bozza: un'altra modifica mantiene le tue modifiche non sottoposte a 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>"
}

Richiede sites:write. Non costa crediti. Il percorso termina con /workspace:run.

L’area di lavoro è una shell su una copia di lavoro della bozza del sito, nel container dedicato del sito, senza connessione alla rete. Usala per le operazioni in cui una shell è più efficace: rg, grep, find, cat, sed -i, node e npx astro build per provare una build in pochi secondi. Il comando viene eseguito nella directory principale del progetto con un utente senza privilegi e senza accesso alla rete.

Le modifiche apportate dal comando restano senza commit. La risposta elenca queste modifiche in uncommitted, una per riga, nel formato di git status (M src/pages/index.astro). Nulla entra nella cronologia finché non esegui il commit dell’area di lavoro, e i visitatori non vedono nulla finché non pubblichi.

command può contenere al massimo 8000 caratteri. timeout_ms può variare da 1000 a 300000 e il valore predefinito è 60000: se il comando è ancora in esecuzione allo scadere del tempo, viene interrotto e timed_out assume il valore true. Un comando che non va a buon fine non genera un errore API: la chiamata riesce e exit_code è diverso da 0. output contiene insieme stdout e stderr; oltre gli 8 KB conserva l’inizio e la fine e truncated assume il valore true.

L’area di lavoro segue la bozza. Se un’altra modifica ha aggiornato la bozza dall’ultimo comando, le modifiche non ancora sottoposte a commit vengono mantenute e note lo segnala. Lo stesso avviene se è stato necessario ricreare l’area di lavoro.

Un sito ancora in fase di creazione risponde con result_not_ready, mentre un sito sospeso o in fase di eliminazione risponde con conflict.

Autorizzazioni

Authorizationbearerin headerrequired

Parametri di percorso

site_idstringrequired

L'ID del sito o il suo slug (l'indirizzo prima di .atelier201.page).

Corpo

application/jsonrequired

commandstringrequiredlength: 1–8000 chars

Un comando bash eseguito nella directory principale del progetto, su una copia di lavoro della bozza: rg, grep, sed, find, cat, node... Nessuna rete. I file modificati restano non sottoposti a commit fino a workspace:commit, che li compila e segnala eventuali errori di build. Qui la build del progetto viene rifiutata: richiedeva 30 s e duplicava quella build.

timeout_msintegerrange: 1000–300000

Valore predefinito: 60000. Il comando viene interrotto allo scadere.

Risposta

application/json

Esegui un comando shell nell'area di lavoro del sito

dataobjectrequired

Show child attributes

data.revisionstringrequiredlength: 40–40 chars

La revisione della bozza da cui è partita l'area di lavoro.

data.exit_codeintegerrequiredrange: -9007199254740991–9007199254740991

data.timed_outbooleanrequired

data.outputstringrequired

stdout e stderr insieme; oltre 8 KB, l'inizio e la fine.

data.truncatedbooleanrequired

data.uncommittedstring[]required

Le modifiche non sottoposte a commit nell'area di lavoro dopo il comando, in stile git status ("M src/pages/index.astro").

data.notestringnullrequired

Indica se l'area di lavoro è stata ricreata o spostata su una bozza più recente prima del 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>" }

Eseguire un comando nell'area di lavoro

Autorizzazioni

Parametri di percorso

Corpo

Risposta

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookie