Skip to main content

​
Overview

This endpoint primarily serves AI Sonar’s OpenAI-compatible Batch API, including uploaded batch inputs and generated output or error files. When the request opts into Anthropic Files compatibility mode, the same route can also list Anthropic-style files available to the bound workspace. Without Anthropic headers, the list can include both batch files and AI Sonar image/reference files. Use purpose=batch, purpose=batch_output, purpose=user_data, or purpose=vision to narrow the list.

​
Notes

  • Batch input files must use purpose=batch.
  • Use purpose=batch_output to focus on generated output files.
  • completion_window is currently 24h.
  • Output ordering is not guaranteed; always match by custom_id.
  • Streaming is not supported inside batch items.

​
Example

​
Request / Response

Use the interactive OpenAPI panel above for the exact schema.

​
Operational Tips

  • Use custom_id for idempotent downstream reconciliation.
  • Expect output_file_id and error_file_id only after the worker finalizes the batch.
  • Batch pricing may differ from synchronous pricing because isBatchRequest=true discount rules apply.

​
Response example

​
Important fields

​
string
Response object type.
​
array
Returned list or payload for this response.