Home
Python
TScurl --no-buffer --request POST \
--url 'http://127.0.0.1:8765/v1/workspaces/{workspace_id}/shell?stream=true' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{"command":"cat","open_stdin":true}'
import requests
url = "http://127.0.0.1:8765/v1/workspaces/{workspace_id}/shell"
payload = { "command": "echo hello" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({command: 'echo hello'})
};
fetch('http://127.0.0.1:8765/v1/workspaces/{workspace_id}/shell', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"exit_code": 0,
"stdout": "hello\n",
"stderr": "",
"refusal": null,
"line_id": "line_019a5e2c-7b41-7c3e-9f20-4d8e1a6b5c37"
}
{"line_id":"line_019a5e2c-7b41-7c3e-9f20-4d8e1a6b5c37"}
{"stream":"stdout","data":"aGVsbG8K"}
{"status":"done","result":{"exit_code":0,"stdout":"","stderr":"","refusal":null,"line_id":"line_019a5e2c-7b41-7c3e-9f20-4d8e1a6b5c37"},"error":null}
Run shell command
Run a shell command or script in the workspace. Check exit_code to determine whether it succeeded.
Set stream=true for live output. Add open_stdin=true to send more input while the command runs. See Streaming and stdin for output formats and input examples.
curl --no-buffer --request POST \
--url 'http://127.0.0.1:8765/v1/workspaces/{workspace_id}/shell?stream=true' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{"command":"cat","open_stdin":true}'
import requests
url = "http://127.0.0.1:8765/v1/workspaces/{workspace_id}/shell"
payload = { "command": "echo hello" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({command: 'echo hello'})
};
fetch('http://127.0.0.1:8765/v1/workspaces/{workspace_id}/shell', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"exit_code": 0,
"stdout": "hello\n",
"stderr": "",
"refusal": null,
"line_id": "line_019a5e2c-7b41-7c3e-9f20-4d8e1a6b5c37"
}
{"line_id":"line_019a5e2c-7b41-7c3e-9f20-4d8e1a6b5c37"}
{"stream":"stdout","data":"aGVsbG8K"}
{"status":"done","result":{"exit_code":0,"stdout":"","stderr":"","refusal":null,"line_id":"line_019a5e2c-7b41-7c3e-9f20-4d8e1a6b5c37"},"error":null}
{
"exit_code": 0,
"stdout": "hello\n",
"stderr": "",
"refusal": null,
"line_id": "line_019a5e2c-7b41-7c3e-9f20-4d8e1a6b5c37"
}
{"line_id":"line_019a5e2c-7b41-7c3e-9f20-4d8e1a6b5c37"}
{"stream":"stdout","data":"aGVsbG8K"}
{"status":"done","result":{"exit_code":0,"stdout":"","stderr":"","refusal":null,"line_id":"line_019a5e2c-7b41-7c3e-9f20-4d8e1a6b5c37"},"error":null}
Errors
Errors
| Status | Meaning |
|---|---|
401 | The token is missing or wrong |
403 | A policy or mount mode refused the call |
404 | The workspace, session, job or file does not exist |
409 | Another server owns command execution for this workspace. The error detail identifies that server. |
422 | Validation Error |
429 | Past a rate limit, or a new session past max_sessions |
413 | The request body, multipart part, or stdin exceeds its size limit. |
499 | The running shell job was canceled. |
500 | The job or server operation failed internally. Inspect detail and server logs before retrying. |
Authorizations
The server's token (MIRAGE_AUTH_TOKEN) or a JWT. A daemon in the default local mode with no token accepts requests without one.
Path Parameters
Workspace ID.
Query Parameters
Session ID to use. If omitted, the default session is used.
Return what the call would do without running it.
Stream stdout, stderr and the final status as NDJSON. Cannot be combined with explain.
Body
Shell command or script to execute.
Working directory for this command only.
Runtime name to use instead of automatic runtime selection.
Machine name to use for this command instead of automatic machine selection.
Include this command in session history.
Keep stdin open for additional input. Requires stream=true; the first response record contains line_id.
Response
Command result, policy evaluation when explain=true, or streamed output ending with a status record when stream=true. With open_stdin, the first record contains line_id.