Sign in

v3

latestOpenAPI 3.1.02026-07-311,4541,5202.3 MB
openAiBatch

Filter Batch Jobs

POST for filtering (not creation) - delegate to GET.

post/api/v1/batches/list/

Headers

Authorizationstring required

Use a dashboard JWT only for dashboard-authenticated endpoints. Respan API-key endpoints use the respanApiKey auth field instead.

Request body

idstring required

Provider's batch ID (e.g., batch_...)

provider_idstring required

Provider ID matching litellm_provider_id (e.g., 'openai', 'parasail')

status'pending' | 'validating' | 'in_progress' | 'finalizing' | 'completed' | 'failed' | 'cancelling' | 'cancelled' | 'expired'
  • pending - Pending
  • validating - Validating
  • in_progress - In Progress
  • finalizing - Finalizing
  • completed - Completed
  • failed - Failed
  • cancelling - Cancelling
  • cancelled - Cancelled
  • expired - Expired
request_countinteger
completed_countinteger
failed_countinteger
total_costnumber double

Total cost calculated from output (populated on completion)

completed_atstring date-time nullable

When batch reached terminal status

last_polled_atstring date-time nullable

Last time status was polled (for smart backoff)

start_log_unique_idstring required

unique_id of the start log (log_type=BATCH)

completion_log_unique_idstring

unique_id of the completion log (populated when status=completed and logged)

{"stackTrail":"components:schemas:BatchJobListRequest:properties:provider_data","oasType":"schema","type":"unknown","description":"Provider metadata (input_file_id, endpoint, etc.)"}

Response

idstring required

Provider's batch ID (e.g., batch_...)

provider_idstring required

Provider ID matching litellm_provider_id (e.g., 'openai', 'parasail')

status'pending' | 'validating' | 'in_progress' | 'finalizing' | 'completed' | 'failed' | 'cancelling' | 'cancelled' | 'expired'
  • pending - Pending
  • validating - Validating
  • in_progress - In Progress
  • finalizing - Finalizing
  • completed - Completed
  • failed - Failed
  • cancelling - Cancelling
  • cancelled - Cancelled
  • expired - Expired
request_countinteger
completed_countinteger
failed_countinteger
total_costnumber double

Total cost calculated from output (populated on completion)

is_usage_trackedstring required
is_activestring required
is_terminalstring required
created_atstring date-time required
updated_atstring date-time required
completed_atstring date-time nullable

When batch reached terminal status

last_polled_atstring date-time nullable

Last time status was polled (for smart backoff)

start_log_unique_idstring required

unique_id of the start log (log_type=BATCH)

completion_log_unique_idstring

unique_id of the completion log (populated when status=completed and logged)

{"stackTrail":"components:schemas:BatchJobList:properties:provider_data","oasType":"schema","type":"unknown","description":"Provider metadata (input_file_id, endpoint, etc.)"}