> ## Documentation Index
> Fetch the complete documentation index at: https://docs.parse.bot/llms.txt
> Use this file to discover all available pages before exploring further.

# Get task detail

> Get full details for a dispatch task, including the generated API spec with endpoint definitions and execution URLs when completed.



## OpenAPI

````yaml /openapi.json get /dispatch/tasks/{task_id}
openapi: 3.1.0
info:
  title: Parse API
  description: Programmatic API for creating, managing, and executing web scraping APIs.
  version: 2.0.0
servers:
  - url: https://api.parse.bot
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Execute
    description: Call the endpoints of an API you've built — the most common operation
  - name: Marketplace
    description: >-
      Browse and search the public marketplace of pre-built APIs (no auth
      required)
  - name: Dispatch
    description: Create and manage scraping APIs
  - name: Export
    description: Export API specs in standard formats
  - name: Updates
    description: Check and merge upstream improvements to your APIs
paths:
  /dispatch/tasks/{task_id}:
    get:
      tags:
        - Dispatch
      summary: Get task detail
      description: >-
        Get full details for a dispatch task, including the generated API spec
        with endpoint definitions and execution URLs when completed.
      operationId: get_task
      parameters:
        - name: task_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Task detail
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskDetail'
components:
  schemas:
    TaskDetail:
      type: object
      properties:
        id:
          type: string
        url:
          type: string
        task:
          type: string
          nullable: true
        status:
          type: string
          enum:
            - queued
            - running
            - needs_input
            - completed
            - failed
            - cancelled
          description: >-
            Task lifecycle state. Poll until it reaches a terminal state:
            completed, failed, or cancelled.
        iteration:
          type: integer
          nullable: true
        user_input_prompt:
          type: object
          nullable: true
          description: >-
            Present when status is 'needs_input' — the question(s) the agent
            needs answered. Respond via POST /dispatch/{task_id}.
        result_scraper_id:
          type: string
          nullable: true
          description: Set on completion — the scraper_id used to execute endpoints.
        result_marketplace_id:
          type: string
          nullable: true
        error:
          type: string
          nullable: true
          description: Set when status is 'failed'.
        created_at:
          type: string
          nullable: true
        updated_at:
          type: string
          nullable: true
        completed_at:
          type: string
          nullable: true
        parent_task_id:
          type: string
          nullable: true
        extends_scraper_id:
          type: string
          nullable: true
        revision_type:
          type: string
          nullable: true
        auth_enabled:
          type: boolean
          default: false
          description: True if this API was built against a site that requires login.
        source:
          type: string
          enum:
            - built
            - subscribed
            - forked
          default: built
          description: How the user acquired this API.
        contributes_to_marketplace:
          type: boolean
          default: true
        progress:
          type: object
          description: >-
            Live build progress while status is 'running' (stage, headline,
            per-endpoint status, log).
          additionalProperties: true
        marketplace_apis:
          type: object
          nullable: true
        existing_marketplace_apis:
          type: object
          nullable: true
        generated_api:
          $ref: '#/components/schemas/GeneratedAPI'
          nullable: true
    GeneratedAPI:
      type: object
      properties:
        marketplace_id:
          type: string
        scraper_id:
          type: string
        name:
          type: string
        description:
          type: string
          nullable: true
        source_url:
          type: string
        execution_base_url:
          type: string
          description: >-
            Base URL for executing endpoints:
            {execution_base_url}/{endpoint_name}
        endpoints:
          type: array
          items:
            $ref: '#/components/schemas/EndpointSpec'
    EndpointSpec:
      type: object
      properties:
        method:
          type: string
          description: HTTP method (GET, POST, etc.)
        endpoint_name:
          type: string
          description: Endpoint path segment
        description:
          type: string
        input_params:
          type: object
        return_schema:
          type: object
        initiates_session:
          type: boolean
          description: >-
            True for a login endpoint that returns a session — see Authenticated
            APIs.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API key for programmatic access. Create one in the Parse dashboard at
        https://parse.bot (Settings → API Keys). Keys start with 'pmx_'.

````