Task Runs

Set a task run output

Changed on

Set a named output on a task run. Output names are lower-cased on write, matching how templating (tasks['<task_id>'].outputs.<name>) resolves them. Names may hold letters, digits and _ - . / =; read one containing . or / with bracket syntax too, e.g. tasks['<task_id>'].outputs['moo2.txt'].

post/task_runs/{task_run_id}/outputs

Request

  • Base URL
    https://app.getorchestra.io/api/engine/public
  • URL
    https://app.getorchestra.io/api/engine/public/task_runs/{task_run_id}/outputs
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getorchestra.io/oauth/authorize
      Token URL: https://app.getorchestra.io/oauth/token scopes: orchestra:write

Path parameters

task_run_idstring uuid4 required

Task run ID.

Headers

X-Orchestra-Account-Idstring uuid4 nullable

Act on this account rather than the one the credential resolves to. Omit it to use the credential's own account. An API key is issued to a single account, so it may only name that account; an OAuth token may name any account its grant covers.

Request body

outputNamestring required
outputValueunknown required

Response

Successful Response

Changes