Skip to main content
POST
/
api
/
crew-templates
/
{template_id}
/
run
Run template
curl --request POST \
  --url https://api.example.com/api/crew-templates/{template_id}/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "values": {}
}'
{
  "correlation_id": "<string>",
  "status": "pending",
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
template_id
string<uuid>
required

Body

application/json

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

​
values
Values · object

Map of variable.name → user-supplied value. Validated against the template's declared variables, such as required-ness, type, and choices before the crew runs.

Response

Successful Response

Response returned after a crew run starts.

​
correlation_id
string
required
​
status
enum<string>
default:pending
Available options:
pending,
running,
completed,
failed
​
message
string | null