sites

Exécuter une commande dans l’espace de travail

Une commande bash exécutée à la racine du projet, sur une copie de travail du brouillon dans le conteneur du site : rg, grep, sed, find, cat, node. La compilation du projet est refusée (400) : workspace:commit soumet les fichiers aux mêmes vérifications que toute autre modification et lance la véritable compilation, dont getSiteBuild signale les erreurs. Aucun accès réseau, durée maximale de 300 s. Les fichiers modifiés restent non validés (indiqués dans uncommitted) jusqu’à workspace:commit. L’espace de travail suit le brouillon : toute nouvelle modification conserve vos changements non validés.

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

Nécessite sites:write. Ne coûte aucun crédit. Le chemin se termine par /workspace:run.

L’espace de travail est un shell exécuté hors ligne dans le conteneur propre au site, sur une copie de travail de son brouillon. Utilisez-le pour les tâches adaptées au shell : rg, grep, find, cat, sed -i, node et npx astro build, pour tester une compilation en quelques secondes. La commande s’exécute à la racine du projet avec un compte sans privilèges, sans accès au réseau.

Les modifications apportées par la commande ne sont pas validées. La réponse les répertorie dans uncommitted, à raison d’une par ligne, au format de git status (M src/pages/index.astro). Rien n’est ajouté à l’historique tant que vous n’avez pas validé l’espace de travail, et les visiteurs ne voient rien tant que vous n’avez pas publié.

command peut contenir jusqu’à 8000 caractères. timeout_ms doit être compris entre 1000 et 300000 et vaut 60000 par défaut : une commande toujours en cours à l’issue de ce délai est arrêtée et timed_out vaut true. L’échec d’une commande ne constitue pas une erreur d’API : l’appel réussit et exit_code est différent de 0. output regroupe stdout et stderr ; au-delà de 8 KB, il conserve le début et la fin, et truncated vaut true.

L’espace de travail suit l’évolution du brouillon. Si une autre modification a fait évoluer le brouillon depuis votre dernière commande, vos modifications non validées sont conservées et note le signale. Il en va de même si l’espace de travail a dû être recréé.

Un site dont la création est toujours en cours renvoie result_not_ready. Un site suspendu ou en cours de suppression renvoie conflict.

Autorisations

Authorizationbearerin headerrequired

Paramètres de chemin

site_idstringrequired

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

Corps

application/jsonrequired

commandstringrequiredlength: 1–8000 chars

Une commande bash exécutée à la racine du projet, sur une copie de travail du brouillon : rg, grep, sed, find, cat, node... Aucun accès réseau. Les fichiers modifiés restent non validés jusqu’à workspace:commit, qui les compile et signale les erreurs éventuelles. La compilation du projet est refusée ici : elle a pris 30 s et ferait doublon.

timeout_msintegerrange: 1000–300000

Valeur par défaut : 60000. La commande est interrompue au-delà de cette durée.

Réponse

application/json

Exécuter une commande shell dans l’espace de travail du site

dataobjectrequired

Show child attributes

data.revisionstringrequiredlength: 40–40 chars

La révision du brouillon à partir de laquelle l’espace de travail a été créé.

data.exit_codeintegerrequiredrange: -9007199254740991–9007199254740991

data.timed_outbooleanrequired

data.outputstringrequired

stdout et stderr réunis ; au-delà de 8 KB, le début et la fin.

data.truncatedbooleanrequired

data.uncommittedstring[]required

Les changements non validés de l’espace de travail après la commande, au format de git status ("M src/pages/index.astro").

data.notestringnullrequired

Indique que l’espace de travail a été recréé ou basculé vers un brouillon plus récent avant l’exécution de la commande.

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

Exécuter une commande dans l’espace de travail

Autorisations

Paramètres de chemin

Corps

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