v1

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-05-044743166.6 KB

tasks

Trigger a task

Trigger a task by its identifier.

post/api/v1/tasks/{taskIdentifier}/trigger

Request body

{"stackTrail":"components:schemas:TriggerTaskRequestBody:properties:payload","oasType":"schema","type":"unknown","description":"The payload can include any valid JSON"}

{"stackTrail":"components:schemas:TriggerTaskRequestBody:properties:context","oasType":"schema","type":"unknown","description":"The context can include any valid JSON"}

Example request

{
  "options": {
    "tags": "user_123456",
    "machine": "small-2x"
  }
}

Response

Task triggered successfully

idstring

The ID of the run that was triggered.

Example response

{
  "id": "run_1234"
}