Script.run¶
Beta: This API may change shape in 0.1.x. It is not a frozen 1.0 contract.
Queue a server-side run (HTTP 202).
Server: POST /api/scripts/{id}/run/.
Signature¶
run(*, version_id: str | None=None, config: dict[str, Any] | None=None, input_dataset_ids: list[str] | None=None) -> dict[str, Any]
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
version_id |
str \| None |
no | None |
config |
dict[str, Any] \| None |
no | None |
input_dataset_ids |
list[str] \| None |
no | None |
HTTP parameters¶
| Name | In | Type | Required | Default |
|---|---|---|---|---|
script_id |
path |
string |
yes | - |
Fields¶
Schema: ScriptRunIn
| Field | Type | Required |
|---|---|---|
config |
object |
no |
input_dataset_ids |
array<string> |
no |
version_id |
string |
no |
Return shape¶
HTTP 202 — Accepted
Schema: ScriptRunSchema
| Field | Type | Required |
|---|---|---|
client_run_id |
string |
no |
config |
object |
no |
content_hash |
string |
yes |
created_at |
string |
yes |
created_by_id |
string |
yes |
duration_ms |
integer |
no |
error_message |
string |
no |
executor |
string |
yes |
exit_code |
integer |
no |
file_type |
string |
yes |
finished_at |
string |
no |
git_sha |
string |
no |
id |
string |
yes |
input_dataset_ids |
array<string> |
no |
log_excerpt |
string |
no |
log_url |
string |
no |
output_dataset_ids |
array<string> |
no |
project_id |
string |
yes |
runtime |
string |
no |
script_name |
string |
yes |
script_version_id |
string |
no |
sdk_version |
string |
yes |
seed |
string |
no |
size |
integer |
yes |
started_at |
string |
no |
status |
string |
yes |
timeout_seconds |
integer |
no |
Permission¶
Required permission: script:run
HTTP¶
POST /api/scripts/{id}/run/ (runScript)
Usage¶
script.run()