Skip to main content
POST
Run template

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-correlation-id
string | null

Path Parameters

template_id
string<uuid>
required

ID of the crew template.

Body

application/json

Run a saved crew template with concrete values for its variables.

values
Values · object

Key-value pairs of variable names and their values, as declared in the template. Call GET /api/crew-templates/{template_id} first to see the available variable names.

Response

Successful Response

Response returned after a crew run starts.

correlation_id
string
required

ID for the crew run.

status
enum<string>
default:pending

State of the run. Always pending here, since the run has only just started.

Available options:
pending,
running,
completed,
failed
message
string | null

Human-readable note about the run, such as which crew started.