LlamaParse Job Dashboard API

The Job Dashboard API from LlamaParse — 1 operation(s) for job dashboard.

OpenAPI Specification

llamaparse-job-dashboard-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Llama Platform Agent Data Job Dashboard API
  version: 0.1.0
tags:
- name: Job Dashboard
paths:
  /api/v1/job-data-points:
    get:
      tags:
      - Job Dashboard
      summary: Query project job data points
      description: Returns paginated job data points for the current project.
      operationId: list_project_job_data_points_api_v1_job_data_points_get
      security:
      - HTTPBearer: []
      parameters:
      - name: job_type
        in: query
        required: true
        schema:
          enum:
          - extract
          - parse
          - classify
          type: string
          description: Job type to query.
          examples:
          - parse
          title: Job Type
        description: Job type to query.
      - name: hours
        in: query
        required: false
        schema:
          type: integer
          maximum: 168
          minimum: 1
          description: Hours of history to include.
          examples:
          - 24
          default: 1
          title: Hours
        description: Hours of history to include.
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter by status.
          examples:
          - - completed
            - failed
          title: Status
        description: Filter by status.
      - name: page_size
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Number of items per page.
          examples:
          - 100
          title: Page Size
        description: Number of items per page.
      - name: page_token
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Cursor token for the next page.
          title: Page Token
        description: Cursor token for the next page.
      - name: created_at_on_or_after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          description: Include items created at or after this timestamp (inclusive)
          title: Created At On Or After
        description: Include items created at or after this timestamp (inclusive)
      - name: created_at_on_or_before
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          description: Include items created at or before this timestamp (inclusive)
          title: Created At On Or Before
        description: Include items created at or before this timestamp (inclusive)
      - name: project_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Project Id
      - name: organization_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Organization Id
      - name: session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Session
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobDataPointResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    JobDataPointResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/JobDataPoint'
          type: array
          title: Items
          description: The list of items.
        next_page_token:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Page Token
          description: A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
        total_size:
          anyOf:
          - type: integer
          - type: 'null'
          title: Total Size
          description: The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.
      type: object
      required:
      - items
      title: JobDataPointResponse
      description: Paginated list of job data points.
    JobStateTransitions:
      properties:
        pending_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Pending At
          examples:
          - '2026-04-29T18:00:00Z'
        throttled_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Throttled At
          examples:
          - '2026-04-29T18:00:02Z'
        running_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Running At
          examples:
          - '2026-04-29T18:00:05Z'
        completed_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Completed At
          examples:
          - '2026-04-29T18:01:00Z'
        failed_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Failed At
          examples:
          - '2026-04-29T18:01:00Z'
        cancelled_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Cancelled At
          examples:
          - '2026-04-29T18:01:00Z'
      type: object
      title: JobStateTransitions
      description: 'State transition timestamps extracted from job_metadata.


        Matches the shape of StateTransitionTimestamps from job_latency/base.py

        with the addition of pending_at. The frontend derives queue latency,

        processing time, etc. from these timestamps.'
    JobDataPoint:
      properties:
        id:
          type: string
          title: Id
          description: Job ID.
          examples:
          - pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
        project_id:
          type: string
          title: Project Id
          description: Project ID.
          examples:
          - 11111111-1111-1111-1111-111111111111
        created_at:
          type: string
          format: date-time
          title: Created At
          description: Created timestamp.
        updated_at:
          type: string
          format: date-time
          title: Updated At
          description: Updated timestamp.
        status:
          type: string
          title: Status
          description: Job status.
          examples:
          - completed
        custom_tag:
          type: string
          title: Custom Tag
          description: Custom tag.
          examples:
          - premium
          - default
        error_message:
          anyOf:
          - type: string
          - type: 'null'
          title: Error Message
          description: Error message, if any.
          examples:
          - Failed to process file.
        state_transitions:
          $ref: '#/components/schemas/JobStateTransitions'
          description: Job state transition timestamps.
      type: object
      required:
      - id
      - project_id
      - created_at
      - updated_at
      - status
      - custom_tag
      title: JobDataPoint
      description: A job data point.
      examples:
      - created_at: '2026-04-29T18:00:00Z'
        custom_tag: premium
        id: pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
        project_id: 11111111-1111-1111-1111-111111111111
        state_transitions:
          completed_at: '2026-04-29T18:01:00Z'
          pending_at: '2026-04-29T18:00:00Z'
          running_at: '2026-04-29T18:00:05Z'
        status: completed
        updated_at: '2026-04-29T18:01:00Z'
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer