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

# Read a run

> Free. Also available at GET /v2/asks/{id}.



## OpenAPI

````yaml /openapi/apiosk-api.json get /v2/runs/{id}
openapi: 3.1.0
info:
  title: Apiosk API
  version: 2.0.0
  description: >-
    Buy verifiable data per call with an organisation API key. Discover sources,
    run one directly, or let Apiosk plan across sources. Amounts are USD; every
    amount carries an exact micro-USD integer.
servers:
  - url: https://gateway.apiosk.com
security:
  - apiKey: []
paths:
  /v2/runs/{id}:
    get:
      summary: Read a run
      description: Free. Also available at GET /v2/asks/{id}.
      operationId: getRun
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: wait_seconds
          in: query
          schema:
            type: integer
            minimum: 0
            maximum: 55
            default: 25
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 50
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  status:
                    type: string
                    enum:
                      - requires_approval
                      - running
                      - completed
                      - partial
                      - needs_input
                      - needs_selection
                      - unsupported
                      - cancelled
                      - failed
                  question:
                    type: string
                  plan:
                    type: object
                    properties:
                      quote_ref:
                        type: string
                        format: uuid
                      expires_at:
                        type: string
                        format: date-time
                      steps:
                        type: array
                        items:
                          type: object
                          properties:
                            source_id:
                              type: string
                              example: kvk
                            operation:
                              type: string
                              example: company_registry.search
                            name:
                              type: string
                            conditional:
                              type: boolean
                            estimated_cost:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 0.023
                                amount_micro_usd:
                                  type: string
                                  example: '23000'
                                currency:
                                  type: string
                                  example: USD
                      estimated_total:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                  answer:
                    type:
                      - object
                      - 'null'
                    description: >-
                      Apiosk's reading of the results, with evidence pointers.
                      Null for a direct call.
                  data:
                    type: object
                    description: The source document, when the run produced exactly one.
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        result_ref:
                          type: string
                          format: uuid
                        source:
                          type: object
                          properties:
                            provider:
                              type: string
                            name:
                              type: string
                        data:
                          type: object
                  usage:
                    type: object
                    properties:
                      sources:
                        type: array
                        items:
                          type: object
                          properties:
                            source_id:
                              type: string
                            operation:
                              type: string
                            calls:
                              type: integer
                            cost:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 0.023
                                amount_micro_usd:
                                  type: string
                                  example: '23000'
                                currency:
                                  type: string
                                  example: USD
                      cost:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                      held:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                  balance:
                    type: object
                    properties:
                      remaining:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                  retry_after_ms:
                    type: integer
        '202':
          description: Still running
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  status:
                    type: string
                    enum:
                      - requires_approval
                      - running
                      - completed
                      - partial
                      - needs_input
                      - needs_selection
                      - unsupported
                      - cancelled
                      - failed
                  question:
                    type: string
                  plan:
                    type: object
                    properties:
                      quote_ref:
                        type: string
                        format: uuid
                      expires_at:
                        type: string
                        format: date-time
                      steps:
                        type: array
                        items:
                          type: object
                          properties:
                            source_id:
                              type: string
                              example: kvk
                            operation:
                              type: string
                              example: company_registry.search
                            name:
                              type: string
                            conditional:
                              type: boolean
                            estimated_cost:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 0.023
                                amount_micro_usd:
                                  type: string
                                  example: '23000'
                                currency:
                                  type: string
                                  example: USD
                      estimated_total:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                  answer:
                    type:
                      - object
                      - 'null'
                    description: >-
                      Apiosk's reading of the results, with evidence pointers.
                      Null for a direct call.
                  data:
                    type: object
                    description: The source document, when the run produced exactly one.
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        result_ref:
                          type: string
                          format: uuid
                        source:
                          type: object
                          properties:
                            provider:
                              type: string
                            name:
                              type: string
                        data:
                          type: object
                  usage:
                    type: object
                    properties:
                      sources:
                        type: array
                        items:
                          type: object
                          properties:
                            source_id:
                              type: string
                            operation:
                              type: string
                            calls:
                              type: integer
                            cost:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 0.023
                                amount_micro_usd:
                                  type: string
                                  example: '23000'
                                currency:
                                  type: string
                                  example: USD
                      cost:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                      held:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                  balance:
                    type: object
                    properties:
                      remaining:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                  retry_after_ms:
                    type: integer
        '401':
          description: invalid_api_key, api_key_expired or api_key_revoked
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                    properties:
                      code:
                        type: string
                        example: invalid_source_input
                      message:
                        type: string
                      required_scope:
                        type: string
                      limit:
                        type: string
                        enum:
                          - per_request
                          - monthly
                          - max_spend
                          - daily
                      required:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                      available:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                      field:
                        type: string
                      missing:
                        type: array
                        items:
                          type: string
                      expected:
                        type: array
                        items:
                          type: string
                      operations:
                        type: array
                        items:
                          type: string
                      retry_after_ms:
                        type: integer
        '403':
          description: insufficient_scope or organisation_unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                    properties:
                      code:
                        type: string
                        example: invalid_source_input
                      message:
                        type: string
                      required_scope:
                        type: string
                      limit:
                        type: string
                        enum:
                          - per_request
                          - monthly
                          - max_spend
                          - daily
                      required:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                      available:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                      field:
                        type: string
                      missing:
                        type: array
                        items:
                          type: string
                      expected:
                        type: array
                        items:
                          type: string
                      operations:
                        type: array
                        items:
                          type: string
                      retry_after_ms:
                        type: integer
        '404':
          description: run_not_found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                    properties:
                      code:
                        type: string
                        example: invalid_source_input
                      message:
                        type: string
                      required_scope:
                        type: string
                      limit:
                        type: string
                        enum:
                          - per_request
                          - monthly
                          - max_spend
                          - daily
                      required:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                      available:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                      field:
                        type: string
                      missing:
                        type: array
                        items:
                          type: string
                      expected:
                        type: array
                        items:
                          type: string
                      operations:
                        type: array
                        items:
                          type: string
                      retry_after_ms:
                        type: integer
        '429':
          description: rate_limit_exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                    properties:
                      code:
                        type: string
                        example: invalid_source_input
                      message:
                        type: string
                      required_scope:
                        type: string
                      limit:
                        type: string
                        enum:
                          - per_request
                          - monthly
                          - max_spend
                          - daily
                      required:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                      available:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                      field:
                        type: string
                      missing:
                        type: array
                        items:
                          type: string
                      expected:
                        type: array
                        items:
                          type: string
                      operations:
                        type: array
                        items:
                          type: string
                      retry_after_ms:
                        type: integer
        '502':
          description: source_error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                    properties:
                      code:
                        type: string
                        example: invalid_source_input
                      message:
                        type: string
                      required_scope:
                        type: string
                      limit:
                        type: string
                        enum:
                          - per_request
                          - monthly
                          - max_spend
                          - daily
                      required:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                      available:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                      field:
                        type: string
                      missing:
                        type: array
                        items:
                          type: string
                      expected:
                        type: array
                        items:
                          type: string
                      operations:
                        type: array
                        items:
                          type: string
                      retry_after_ms:
                        type: integer
        '503':
          description: service_unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                    properties:
                      code:
                        type: string
                        example: invalid_source_input
                      message:
                        type: string
                      required_scope:
                        type: string
                      limit:
                        type: string
                        enum:
                          - per_request
                          - monthly
                          - max_spend
                          - daily
                      required:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                      available:
                        type: object
                        properties:
                          amount:
                            type: number
                            example: 0.023
                          amount_micro_usd:
                            type: string
                            example: '23000'
                          currency:
                            type: string
                            example: USD
                      field:
                        type: string
                      missing:
                        type: array
                        items:
                          type: string
                      expected:
                        type: array
                        items:
                          type: string
                      operations:
                        type: array
                        items:
                          type: string
                      retry_after_ms:
                        type: integer
components:
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: 'An organisation API key: Authorization: Bearer apk_org_live_…'

````