Path parameters

• batch_id string Required

  The ID of the batch to retrieve.

Responses

• 200 application/json

  Batch retrieved successfully.

  Hide response attributes Show response attributes object

  • id string Required
  • object string Required

    The object type, which is always batch.

    Value is batch.

  • endpoint string Required

    The OpenAI API endpoint used by the batch.

  • errors object
    Hide errors attributes Show errors attributes object

    • object string

      The object type, which is always list.

    • data array[object]
      Hide data attributes Show data attributes object

      • code string

        An error code identifying the error type.

      • message string

        A human-readable message providing more details about the error.

      • param string | null

        The name of the parameter that caused the error, if applicable.

      • line integer | null

        The line number of the input file where the error occurred, if applicable.

  • input_file_id string Required

    The ID of the input file for the batch.

  • completion_window string Required

    The time frame within which the batch should be processed.

  • status string Required

    The current status of the batch.

    Values are validating, failed, in_progress, finalizing, completed, expired, cancelling, or cancelled.

  • output_file_id string

    The ID of the file containing the outputs of successfully executed requests.

  • error_file_id string

    The ID of the file containing the outputs of requests with errors.

  • created_at integer Required

    The Unix timestamp (in seconds) for when the batch was created.

  • in_progress_at integer

    The Unix timestamp (in seconds) for when the batch started processing.

  • expires_at integer

    The Unix timestamp (in seconds) for when the batch will expire.

  • finalizing_at integer

    The Unix timestamp (in seconds) for when the batch started finalizing.

  • completed_at integer

    The Unix timestamp (in seconds) for when the batch was completed.

  • failed_at integer

    The Unix timestamp (in seconds) for when the batch failed.

  • expired_at integer

    The Unix timestamp (in seconds) for when the batch expired.

  • cancelling_at integer

    The Unix timestamp (in seconds) for when the batch started cancelling.

  • cancelled_at integer

    The Unix timestamp (in seconds) for when the batch was cancelled.

  • request_counts object

    The request counts for different statuses within the batch.

    Hide request_counts attributes Show request_counts attributes object

    • total integer Required

      Total number of requests in the batch.

    • completed integer Required

      Number of requests that have been completed successfully.

    • failed integer Required

      Number of requests that have failed.

  • metadata object | null

    Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

    Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

    Hide metadata attribute Show metadata attribute object | null

    • * string Additional properties