Worker Tasks

Worker tasks enable distributed task processing where multiple contributors can submit results for the same task. The system supports consensus-based resolution where multiple result submissions are collected and compared. Tasks can be accessed via both /worker/tasks and /contributor/tasks routes.

Endpoints

List Tasks

GET /api/v2/worker/tasks
GET /api/v2/contributor/tasks

Retrieves a paginated list of worker tasks for the current user.

Query Parameters

Response

{
  "data": [
    {
      "id": 1,
      "created_at": "2024-03-15T10:00:00Z",
      "created_by_id": 7,
      "completed_at": null,
      "status": "PENDING",
      "task_type": "document_classification",
      "relation_type": "voucher",
      "relation_id": 123,
      "secondary_relation_type": null,
      "secondary_relation_id": null,
      "comment": "Classify this document"
    }
  ],
  "meta": {
    "page": 1,
    "pages": 1,
    "per_page": 100,
    "records": 1
  }
}

Get Task

GET /api/v2/contributor/tasks/{id}

Retrieves a specific worker task by ID.

Create Task

POST /api/v2/contributor/tasks

Creates a new worker task.

Request Body

Response

Returns the created task with status 201 Created.

Update Task

PATCH /api/v2/contributor/tasks/{id}

Updates a worker task. Currently only supports cancelling a pending task.

Request Body

Response

Returns the updated task.

Submit Result

POST /api/v2/worker/tasks/{id}/results
POST /api/v2/contributor/tasks/{id}/results

Submits a result for a worker task. Multiple users can submit results for the same task.

Request Body

Response

{
  "id": 1,
  "submitted_at": "2024-03-15T11:00:00Z",
  "submitted_by_id": 7,
  "task_id": 1,
  "status": "SUBMITTED",
  "data": {
    "classification": "invoice",
    "confidence": 0.95
  }
}

Attributes

Worker Task

Worker Task Result

Relationships

Business Rules

1. Only PENDING tasks can be cancelled
2. Results cannot be submitted for COMPLETED tasks
3. Multiple users can submit results for the same task (consensus-based)
4. Tasks are automatically filtered to the current user’s scope

Error Responses

Related Resources

• Tasks
• Documents
• Vouchers