Skip to main content

Overview

This endpoint is part of AI Sonar’s OpenAI-compatible Batch API. Batch jobs use uploaded JSONL files, run asynchronously, and can return output/error files later.

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.
  • Supported batch item endpoints are currently /v1/chat/completions and /v1/embeddings; /v1/responses batch jobs are rejected until a native Responses batch executor is available.

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
Identifier used for follow-up calls and support.
string
Current lifecycle state for this resource.
string|null
File identifier used by related APIs.