Runtime reference

Tasks running on Airplane have access to special environment variables / APIs.
The Airplane SDKs serve as idiomatic wrappers around the underlying Airplane Runtime API. For languages without an official SDK, you can instead create your own unofficial SDK by implementing the Runtime SDK.
Even if you're using an SDK, you may find access to the environment variables useful.

Environment variables

When a run is executing, Airplane will set the following environment variables:
  • AIRPLANE_SCHEDULE_ID: the ID (if any) of the schedule that triggered the run.
  • AIRPLANE_TASK_ID: the ID of the task the run belongs to.
  • AIRPLANE_RUNNER_ID: the ID of the user who executed the run. If this run was requested, it is the user who executed the run, not the requester.
  • AIRPLANE_RUNNER_EMAIL: the email of the user who executed the run.
  • AIRPLANE_RUN_ID: the ID of the run.

Outputs

Airplane outputs are produced by writing to stdout using either the airplane_output_set or airplane_output_append prefix. For example:
bash
Copied
1
airplane_output_set "Hello World!"
See Outputs for further details.