Skip to main content

Overview

This endpoint primarily serves AI Sonar’s OpenAI-compatible Batch API file content retrieval. When the request opts into Anthropic Files compatibility mode, the same route can proxy the original stored file content for the bound workspace. Without Anthropic headers, this route downloads batch file content or proxies content for a bound image/reference file when the provider supports file content retrieval.

Notes

  • Batch input files must use purpose=batch.
  • 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

binary|string
Raw response body. Save it directly instead of parsing it as JSON.
string
Identifier used for follow-up calls and support.