Runs API
The Airplane API is currently available to customers as a beta and is subject to change. Please reach out to us at hello@airplane.dev with any feedback!
A run represents an instance of a task's execution. See Tasks API for how to execute tasks.
Endpoints
Get Run
Get information about an existing run.
Query Parameters
ID of the run to retrieve.
Response
When the run became active. Empty if this run has not started yet.
When the run was cancelled. Empty if this run was not cancelled.
ID of the user who cancelled this run.
When this run was created.
ID of the user that created this run.
When the run failed. Empty if this run did not fail.
Unique ID of this run.
Whether or not this run is private.
Mapping of parameter name to value used in this run's execution.
Schema for the set of values users can provide when executing this run. More details.
Explicit permissions of this run if it is private. More details.
Mapping of resouce name to resource ID of the resources that were used for this run. More details.
ID of the session this run was spawned from if triggered by a session.
Status of this run.
Possible Values |
NotStarted |
Queued |
Active |
Succeeded |
Failed |
When the run succeeded. Empty if this run did not succeed.
ID of the task this run was spawned from if triggered by a task.
ID of the team that owns this run.
Maximum amount of time in seconds the run could have executed for. More details.
Get Run Outputs
Get outputs from an existing run.
Query Parameters
ID of the run to retrieve.
Response
Outputs from this run. More details.