Pathwize API

openapi: 3.1.0
info:
  title: Pathwize API
  version: '2026-11-10'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-10: 16 operation(s) read from 6 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Pathwize has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 5
    documentation: 11
    pages-with-code: 6
    pages-read: 6
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-10'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://www.gopathwize.com/docs/webhooks
  - https://www.gopathwize.com/docs/introduction
  - https://www.gopathwize.com/docs/authentication
  - https://www.gopathwize.com/docs/tasks
  - https://www.gopathwize.com/docs/items
  - https://www.gopathwize.com/docs/results
paths:
  /api/v1:
    get:
      operationId: get_api_v1
      tags:
      - Api
      summary: GET /api/v1
      x-source: https://www.gopathwize.com/docs/introduction
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: httpie
        snippet: HTTP https://www.gopathwize.com/api/v1 All endpoints live under this base. Requests and responses are UTF-8 JSON, except results
          in format=jsonl which stream one JSON object per line. Timestamps are ISO 8601 in UTC. Quickstart 1 Create a task in the dashboard under
          AI tasks. Choose the type, the exp
  /api/v1/tasks:
    get:
      operationId: get_api_v1_tasks
      tags:
      - Api
      summary: GET /api/v1/tasks
      x-source: https://www.gopathwize.com/docs/authentication
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl https://www.gopathwize.com/api/v1/tasks  -H "Authorization: Bearer pw_live_..."

          Managing keys

          Keys start with pw_live_. The full key is shown once at creation; afterwards only its prefix.

          You can hold up to 10 active keys, for example one per environment or pipeline.

          Revoking a key takes effect immediately. Create the replacement first, switch, then revoke.

          Keys are hashed at rest. If you los'
  /api/v1/tasks/{taskId}:
    get:
      operationId: get_api_v1_tasks_taskId
      tags:
      - Api
      summary: Retrieve a task
      description: Returns one task with its label schema and item counts, or 404 if the ID is unknown or belongs to another workspace.
      x-source: https://www.gopathwize.com/docs/tasks
      parameters:
      - name: taskId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1TasksTaskidResponse'
      x-evidence:
        kind: documentation
  /api/v1/tasks/{taskId}/items:
    get:
      operationId: get_api_v1_tasks_taskId_items
      tags:
      - Api
      summary: Pathwize API Introduction
      x-source: https://www.gopathwize.com/docs/introduction
      parameters:
      - name: taskId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/tasks/{taskid}/items:
    post:
      operationId: post_api_v1_tasks_taskid_items
      tags:
      - Api
      summary: POST /api/v1/tasks/{taskId}/items
      x-source: https://www.gopathwize.com/docs/introduction
      parameters:
      - name: taskid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1TasksTaskidItemsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl Python Node.js curl https://www.gopathwize.com/api/v1/tasks/TASK_ID/items  -H \"Authorization: Bearer pw_live_...\"  -H\
          \ \"Content-Type: application/json\"  -H \"Idempotency-Key: 2026-09-25-batch-07\"  -d '{ \n \"items\": [ \n { \n \"id\": \"werk-nord-2026-09-25-000871\"\
          , \n \"url\": \"https://storage.example.com/loads/2026-09-25/000871.jpg\", \n \"mime\": \"image/jpeg\", \n \"checksum\": \"sha256:9f3a...\"\
          , \n \"width\": 403"
  /api/v1/tasks/{taskid}/results:
    get:
      operationId: get_api_v1_tasks_taskid_results
      tags:
      - Api
      summary: GET /api/v1/tasks/{taskId}/results
      x-source: https://www.gopathwize.com/docs/results
      parameters:
      - name: taskid
        in: path
        required: true
        schema:
          type: string
      - name: format
        in: query
        required: false
        schema:
          type: string
      - name: since
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1TasksTaskidResultsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl Python Node.js curl "https://www.gopathwize.com/api/v1/tasks/TASK_ID/results?since=2026-09-25T00:00:00Z&format=jsonl"  -H
          "Authorization: Bearer pw_live_..." Query parameters since string Only results labeled after this ISO 8601 timestamp. Use the time of
          your previous poll. starting_after string Item ID to page from (exclusive). limit integer 1 to 1,000, default 100. format string json
          (defa'
  /api/v1/webhooks:
    post:
      operationId: post_api_v1_webhooks
      tags:
      - Api
      summary: POST /api/v1/webhooks
      x-source: https://www.gopathwize.com/docs/webhooks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1WebhooksRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl curl https://www.gopathwize.com/api/v1/webhooks  -H "Authorization: Bearer pw_live_..."  -H "Content-Type: application/json"  -d
          ''{"url":"https://api.example.com/pathwize/webhook","events":["item.labeled","task.completed"]}'' GET /webhooks Lists your endpoints
          with their last delivery status (never the secret). POST /webhooks/{id} Sends a signed ping event to the endpoint and returns whether
          i'
  /tasks:
    get:
      operationId: get_tasks
      tags:
      - Tasks
      summary: List tasks
      description: Returns up to 100 of your tasks, newest first, each with item counts.
      x-source: https://www.gopathwize.com/docs/tasks
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTasksResponse'
      x-evidence:
        kind: documentation
  /tasks/{taskId}:
    get:
      operationId: get_tasks_taskId
      tags:
      - Tasks
      summary: Retrieve a task
      description: Returns one task with its label schema and item counts, or 404 if the ID is unknown or belongs to another workspace.
      x-source: https://www.gopathwize.com/docs/tasks
      parameters:
      - name: taskId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTasksTaskidResponse'
      x-evidence:
        kind: documentation
  /tasks/{taskId}/items:
    get:
      operationId: get_tasks_taskId_items
      tags:
      - Tasks
      summary: List items
      x-source: https://www.gopathwize.com/docs/items
      parameters:
      - name: taskId
        in: path
        required: true
        schema:
          type: string
      - name: status
        in: query
        required: false
        schema:
          type: string
        description: Filter by one status
      - name: since
        in: query
        required: false
        schema:
          type: string
        description: Only items created after this ISO 8601 timestamp
      - name: starting_after
        in: query
        required: false
        schema:
          type: string
        description: Item ID to page from (exclusive)
      - name: limit
        in: query
        required: false
        schema:
          type: integer
        description: 1 to 500, default 100
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTasksTaskidItemsResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_tasks_taskId_items
      tags:
      - Tasks
      summary: Push items by URL
      x-source: https://www.gopathwize.com/docs/items
      parameters:
      - name: taskId
        in: path
        required: true
        schema:
          type: string
      - name: Idempotency-Key
        in: header
        required: false
        schema:
          type: string
        description: Any string up to 255 characters, for example your batch ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostTasksTaskidItemsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostTasksTaskidItemsResponse'
      x-evidence:
        kind: documentation
  /tasks/{taskId}/results:
    get:
      operationId: get_tasks_taskId_results
      tags:
      - Tasks
      summary: Pull labeled items with the experts' answers, agreement and flags.
      description: Returns items that are labeled or flagged, oldest first, flattened so each row is ready to write into your database.
      x-source: https://www.gopathwize.com/docs/results
      parameters:
      - name: taskId
        in: path
        required: true
        schema:
          type: string
      - name: since
        in: query
        required: false
        schema:
          type: string
        description: Only results labeled after this ISO 8601 timestamp. Use the time of your previous poll.
      - name: starting_after
        in: query
        required: false
        schema:
          type: string
        description: Item ID to page from (exclusive).
      - name: limit
        in: query
        required: false
        schema:
          type: integer
        description: 1 to 1,000, default 100.
      - name: format
        in: query
        required: false
        schema:
          type: string
        description: json (default, a list object) or jsonl (one object per line, X-Has-More header for paging).
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTasksTaskidResultsResponse'
      x-evidence:
        kind: documentation
  /webhooks:
    get:
      operationId: get_webhooks
      tags:
      - Webhooks
      summary: Webhooks - Pathwize Documentation
      x-source: https://www.gopathwize.com/docs/webhooks
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_webhooks
      tags:
      - Webhooks
      summary: Webhooks - Pathwize Documentation
      x-source: https://www.gopathwize.com/docs/webhooks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostWebhooksRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /webhooks/{id}:
    delete:
      operationId: delete_webhooks_id
      tags:
      - Webhooks
      summary: Webhooks - Pathwize Documentation
      x-source: https://www.gopathwize.com/docs/webhooks
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_webhooks_id
      tags:
      - Webhooks
      summary: Webhooks - Pathwize Documentation
      x-source: https://www.gopathwize.com/docs/webhooks
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    GetApiV1TasksTaskidResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique task ID.
        title:
          type: string
          description: Task title.
        type:
          type: string
          description: Task type.
        status:
          type: string
          description: Task status.
        mode:
          type: string
          description: Task mode.
        deadline:
          type: string
          description: Deadline (nullable).
        expected_items_per_day:
          type: integer
          description: Expected items per day.
        turnaround_hours:
          type: integer
          description: Turnaround hours.
        raters_per_item:
          type: integer
          description: Raters per item.
        overlap:
          type: object
          description: Overlap settings.
        label_schema:
          type: object
          description: Label schema.
        created_at:
          type: string
          description: Creation timestamp.
        items:
          type: object
          description: Item counts by status.
    PostApiV1TasksTaskidItemsRequest:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              url:
                type: string
              mime:
                type: string
              checksum:
                type: string
              width:
                type: integer
              height:
                type: integer
              captured_at:
                type: string
                format: date-time
              group:
                type: string
              meta:
                type: object
                properties:
                  site:
                    type: string
                  scale_kg:
                    type: integer
    GetApiV1TasksTaskidResultsResponse:
      type: object
      properties:
        id:
          type: string
        status:
          type: string
        label:
          type: string
        labels_all:
          type: array
          items:
            type: string
        agreement:
          type: number
        raters:
          type: integer
        boxes:
          type: array
          items:
            type: object
            properties:
              label:
                type: string
              x:
                type: integer
              y:
                type: integer
              w:
                type: integer
              h:
                type: integer
              rater:
                type: integer
        note:
          type:
          - string
          - 'null'
        flags:
          type: array
          items: {}
        labeled_at:
          type: string
          format: date-time
        group:
          type: string
        captured_at:
          type: string
          format: date-time
        meta:
          type: object
          properties:
            site:
              type: string
            scale_kg:
              type: integer
    PostApiV1WebhooksRequest:
      type: object
      properties:
        url:
          type: string
        events:
          type: array
          items:
            type: string
    GetTasksResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique task ID.
        title:
          type: string
          description: Task title.
        type:
          type: string
          description: Task type.
        status:
          type: string
          description: Task status.
        mode:
          type: string
          description: Task mode.
        deadline:
          type: string
          description: Deadline (nullable).
        expected_items_per_day:
          type: integer
          description: Expected items per day.
        turnaround_hours:
          type: integer
          description: Turnaround hours.
        raters_per_item:
          type: integer
          description: Raters per item.
        overlap:
          type: object
          description: Overlap settings.
        label_schema:
          type: object
          description: Label schema.
        created_at:
          type: string
          description: Creation timestamp.
        items:
          type: object
          description: Item counts by status.
    GetTasksTaskidResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique task ID.
        title:
          type: string
          description: Task title.
        type:
          type: string
          description: Task type.
        status:
          type: string
          description: Task status.
        mode:
          type: string
          description: Task mode.
        deadline:
          type: string
          description: Deadline (nullable).
        expected_items_per_day:
          type: integer
          description: Expected items per day.
        turnaround_hours:
          type: integer
          description: Turnaround hours.
        raters_per_item:
          type: integer
          description: Raters per item.
        overlap:
          type: object
          description: Overlap settings.
        label_schema:
          type: object
          description: Label schema.
        created_at:
          type: string
          description: Creation timestamp.
        items:
          type: object
          description: Item counts by status.
    GetTasksTaskidItemsResponse:
      type: object
      properties:
        items:
          type: array
          description: Array of item objects
    PostTasksTaskidItemsRequest:
      type: object
      properties:
        items:
          type: array
          description: Array of 1 to 1,000 items
        id:
          type: string
          description: Your identifier, unique within the task, up to 200 printable ASCII characters without spaces
        url:
          type: string
          description: HTTPS (or HTTP) URL of the file
        mime:
          type: string
          description: image/jpeg, image/png, image/webp, application/pdf, text/plain or application/json
        checksum:
          type: string
          description: sha256:<hex> of the file
        width:
          type: integer
          description: Pixel width of images
        height:
          type: integer
          description: Pixel height of images
        captured_at:
          type: string
          description: ISO 8601 timestamp when the item was captured
        group:
          type: string
          description: Free grouping key, up to 100 characters
        priority:
          type: integer
          description: 0 normal (default) or 1 urgent
        hints:
          type: object
          description: Up to 2 KB JSON object
        meta:
          type: object
          description: Up to 4 KB of your own data
      required:
      - items
      - id
      - url
      - mime
    PostTasksTaskidItemsResponse:
      type: object
      properties:
        accepted:
          type: integer
          description: Number of items created
        duplicates:
          type: integer
          description: Number of items that already existed
        rejected:
          type: array
          description: List of rejected items with id, param and message
    GetTasksTaskidResultsResponse:
      type: object
      properties:
        id:
          type: string
        status:
          type: string
        label:
          type: string
          description: The final answer after applying your disagreement rule (majority by default). Null when no majority exists and the item
            is flagged.
        labels_all:
          type: string
          description: Every rater's answer, in rater order. With multi-select enabled each entry can be a comma-joined list.
        agreement:
          type: number
          description: Share of raters that gave the final label, 0 to 1. Null for items that had a single rater (outside the overlap sample).
        raters:
          type: integer
          description: How many experts labeled this item.
        boxes:
          type: array
          description: 'For bounding-box tasks: pixel coordinates (top-left origin) per box with its label and rater index. Empty for classification.'
        note:
          type: string
          description: Free-text notes from experts, joined with newlines, when notes are enabled.
        flags:
          type: string
          description: Zero or more of low_agreement, unreadable, wrong_data, needs_review.
        labeled_at:
          type: string
        group:
          type: string
        captured_at:
          type: string
        meta:
          type: object
          description: Exactly what you sent with the item.
    PostWebhooksRequest:
      type: object
      properties:
        url:
          type: string
          description: HTTPS endpoint that accepts POST.
        events:
          type: string
          description: One or more of item.labeled , item.flagged , task.completed.
        description:
          type: string
          description: Free text shown in the dashboard.
      required:
      - url
      - events
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api
- name: Tasks
- name: Webhooks