Skip to content

Tasks

Create a task

POST /external/v1/projects/{project_id}/tasks
FieldTypeRequiredDescription
task_type_identifierstringyesTask type identifier field
paramsobjectnoTask parameters, default {}
namestringnoDisplay name; default {identifier}-{YYYYmmddHHMMSS}
bash
curl -X POST http://localhost:8000/external/v1/projects/PROJECT_ID/tasks \
  -H "Authorization: Bearer API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"task_type_identifier":"web-scraper","params":{"url":"https://example.com"}}'

Response (201): { id, name, status, progress, current_phase, task_type, created_at, … }


List tasks

GET /external/v1/projects/{project_id}/tasks?status=running&limit=10&offset=0

Get task

GET /external/v1/projects/{project_id}/tasks/{task_id}

Response includes params and result in addition to the brief fields.

Built with VitePress