Pathwize API

Tasks

Read your tasks, their label schema and item counts.

A task is the container for items, the label schema and the expert group. Tasks are created in the dashboard; the API reads them and works with their items.

The task object

{
  "id": "601dd0b1-5d5f-4847-b1fa-0ddda0e39f3f",
  "title": "Ladungsklassifikation Werk Nord",
  "type": "data_labeling",
  "status": "open",
  "mode": "ongoing",
  "deadline": null,
  "expected_items_per_day": 300,
  "turnaround_hours": 24,
  "raters_per_item": 1,
  "overlap": { "mode": "sample", "raters": 2, "share_percent": 10 },
  "label_schema": {
    "annotation": "classification",
    "classes": ["Bauschutt", "Erdaushub", "Holz", "Metall", "Gemischt"],
    "multi_select": false,
    "allow_note": true,
    "output_format": "csv",
    "qualification": { "enabled": true, "sample": 50, "threshold": 90, "gold_share": 5 }
  },
  "created_at": "2026-09-24T10:02:11.000Z",
  "items": {
    "total": 5000, "queued": 120, "ready": 380, "in_progress": 40,
    "labeled": 4450, "flagged": 8, "failed": 2
  }
}

Attributes

idstring: Unique task ID. Use it in every item and results request.
typestring: data_labeling, preference, evaluation, red_team or domain.
statusstring: draft, open or closed. Items can be pushed in any status; experts only work on open tasks.
modestring: batch for a fixed set with a deadline, or ongoing for daily pushes with expected_items_per_day and a turnaround_hours target.
raters_per_iteminteger: Experts every item gets. 1 with sample overlap, 2 or 3 when every item is multi-rated.
overlapobject: Quality overlap. sample: one rater per item and share_percent of items get a second rater to measure agreement. all: every item goes to raters experts.
label_schemaobject: Annotation type, classes and options as configured in the dashboard. qualification shows whether candidates take a test on the reference set first (sample items or "all"), the pass mark in percent and the share of hidden reference items in production.
itemsobject: Counts by status. See Items for the lifecycle.

List tasks

GET/tasks

Returns up to 100 of your tasks, newest first, each with item counts.

curl https://www.gopathwize.com/api/v1/tasks -H "Authorization: Bearer pw_live_..."

Retrieve a task

GET/tasks/{task_id}

Returns one task with its label schema and item counts, or 404 if the ID is unknown or belongs to another workspace.

curl https://www.gopathwize.com/api/v1/tasks/TASK_ID -H "Authorization: Bearer pw_live_..."