Sign in
Scripts

Run a reusable or inline script

Inline source skips typecheck and is auto-saved as a scratch script only on success.

post/api/scripts/run

Headers

X-Runtime-Instance-IDstring

Identifies the concrete runtime instance (worker process) making the call, as generated at its boot. Required to acquire work through the script SDK when multi-runtime mode (MULTI_RUNTIME_ENABLED) is on; ignored otherwise.

Identifies the concrete runtime instance (worker process) making the call, as generated at its boot. Required to acquire work through the script SDK when multi-runtime mode (MULTI_RUNTIME_ENABLED) is on; ignored otherwise.

Request body

namestring
sourcestring
{"stackTrail":"paths:/api/scripts/run:post:requestBody:content:application/json:schema:properties:args","oasType":"schema","type":"unknown"}
intentstring
scope'global' | 'agent'
fsMode'none' | 'workspace-rw'
idempotencyKeystring

Response

Script run completed

{"stackTrail":"paths:/api/scripts/run:post:responses:200:content:application/json:schema:properties:result","oasType":"schema","type":"unknown"}
durationMsnumber required
stdoutstring required
stderrstring required
exitCodenumber required
error'timeout' | 'oom' | 'killed' | 'import_violation' | 'eval_error' | 'executor_error'

Changes

Changed in 2 of the 104 revisions of this API.5

  • ea4adca6e9271See the full diff
    • ○

      added the new optional header request parameter X-Runtime-Instance-ID

      new-optional-request-parameter

  • 06cac6a7c5bc4See the full diff
    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    • ○

      added the media type application/json for the response with the status

      response-media-type-added