API Reference tasks

Create a task

POST/projects/{project_id}/tasks/

Create a task instance and dispatch it to the project sandbox.

Parameters

Body field	Required	Description
name	yes	Display name on the board
task_type_id	one of	Meta-task UUID to run
task_type_identifier	one of	Meta-task identifier — provide this or task_type_id, never both
params	no	Values matching the meta-task param schema (default {})
workspace_id / workspace_slug	no	Run against a specific workspace instead of the meta-task default
show_in_kanban	no	false hides the run from the board (default true)
auto_start	no	false creates the task in pending without dispatching (default true)

Request

curl -X POST "$ALLYBUILD_API_URL/projects/$PROJECT_ID/tasks/" \
  -H "Authorization: Bearer $TASK_JWT" \
  -H "Content-Type: application/json"
  -d '{
    "name": "weekly-report",
    "task_type_identifier": "weekly-report",
    "params": {"month": "2026-10"}
  }'

Response

{
  "id": "9a2b8c7d-1e2f-4a5b-8c9d-0e1f2a3b4c5d",
  "name": "weekly-report",
  "task_type_id": "5f4e3d2c-...",
  "params": {"month": "2026-10"},
  "status": "pending",
  "current_phase": null,
  "progress": 0,
  "created_at": "2026-10-01T12:00:00Z",
  "started_at": null,
  "finished_at": null,
  "dependencies": [],
  "error_message": null,
  "pr_url": null
}