sites

Befehl im Workspace ausführen

Ein Bash-Befehl im Stammverzeichnis des Projekts, in einer Arbeitskopie des Entwurfs im Container der Website: rg, grep, sed, find, cat, node. Ein Build des Projekts wird abgelehnt (400): workspace:commit prüft die Dateien wie jede andere Änderung und startet den echten Build. Dessen Fehler meldet getSiteBuild. Kein Netzwerkzugriff, höchstens 300 s. Geänderte Dateien bleiben uncommitted und werden unter uncommitted aufgeführt, bis workspace:commit ausgeführt wird. Der Workspace folgt dem Entwurf: Bei einer weiteren Änderung werden deine uncommitted Änderungen übernommen.

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

Erfordert sites:write. Kostet keine Credits. Der Pfad endet mit /workspace:run.

Der Workspace ist eine Shell in einer Arbeitskopie des Website-Entwurfs, offline im eigenen Container der Website. Verwende ihn für Aufgaben, die sich gut in einer Shell erledigen lassen: rg, grep, find, cat, sed -i, node und npx astro build, um in Sekunden einen Build zu testen. Der Befehl wird als nicht privilegierter Benutzer im Stammverzeichnis des Projekts ausgeführt. Es gibt keine Netzwerkverbindung.

Änderungen durch den Befehl bleiben uncommitted. Die Antwort führt diese Änderungen in uncommitted auf, eine pro Zeile im Stil von git status (M src/pages/index.astro). In den Verlauf gelangt nichts, bis du den Workspace committest, und Besucher sehen erst etwas, wenn du veröffentlichst.

command darf höchstens 8000 Zeichen lang sein. timeout_ms liegt zwischen 1000 und 300000 und ist standardmäßig auf 60000 gesetzt: Läuft ein Befehl zu diesem Zeitpunkt noch, wird er angehalten und timed_out ist true. Ein fehlgeschlagener Befehl ist kein API-Fehler: Der Aufruf ist erfolgreich und exit_code ist nicht 0. output enthält zusammen stdout und stderr. Bei mehr als 8 KB bleiben Anfang und Ende erhalten und truncated ist true.

Der Workspace folgt dem Entwurf. Hat eine andere Änderung den Entwurf seit deinem letzten Befehl verändert, werden deine uncommitted Änderungen übernommen und note weist darauf hin. Dasselbe gilt, wenn der Workspace neu erstellt werden musste.

Eine Website, die noch erstellt wird, antwortet mit result_not_ready. Bei einer ausgesetzten oder gerade gelöschten Website lautet die Antwort conflict.

Autorisierung

Authorizationbearerin headerrequired

Pfadparameter

site_idstringrequired

ID der Website oder ihr Slug (die Adresse vor .atelier201.page).

Body

application/jsonrequired

commandstringrequiredlength: 1–8000 chars

Ein Bash-Befehl im Stammverzeichnis des Projekts, in einer Arbeitskopie des Entwurfs: rg, grep, sed, find, cat, node... Kein Netzwerkzugriff. Geänderte Dateien bleiben uncommitted, bis workspace:commit sie erstellt und Build-Fehler meldet. Ein Build des Projekts wird hier abgelehnt: Er dauerte 30 s und hätte den Build doppelt ausgeführt.

timeout_msintegerrange: 1000–300000

Standardwert 60000. Danach wird der Befehl abgebrochen.

Antwort

application/json

Einen Shell-Befehl im Workspace der Website ausführen

dataobjectrequired

Show child attributes

data.revisionstringrequiredlength: 40–40 chars

Die Revision des Entwurfs, von der der Workspace ausgegangen ist.

data.exit_codeintegerrequiredrange: -9007199254740991–9007199254740991

data.timed_outbooleanrequired

data.outputstringrequired

stdout und stderr zusammen. Bei mehr als 8 KB werden Anfang und Ende ausgegeben.

data.truncatedbooleanrequired

data.uncommittedstring[]required

Die uncommitted Änderungen des Workspace nach dem Befehl, im Stil von git status ("M src/pages/index.astro").

data.notestringnullrequired

Wird angegeben, wenn der Workspace vor dem Befehl neu erstellt oder auf einen neueren Entwurf umgestellt wurde.

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

Befehl im Workspace ausführen

Autorisierung

Pfadparameter

Body

Antwort

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies