Methods: create_batch, retrieve_batch, cancel_batch, get_async_job_websocket_url, batch_websocket_url, async_jobs.websocket_url.
Example
Key parameters
model: Model id used to infer the upstream provider. Most callers should not pass provider.prompts: Simple shorthand for one or more prompt strings.items: Structured prompt shorthand with id / custom_id, prompt, messages, per-row settings, or an advanced body.requests: Advanced inline provider-native batch rows.input_file_id: Existing file id uploaded via /batches/files?model=... for large prebuilt JSONL inputs.endpoint: Optional target endpoint for advanced rows. Phaseo chooses a model/provider default when omitted.completion_window: e.g., 24h.session_id: Optional Phaseo grouping id for logs, sessions, and investigate tooling.webhook: Optional webhook configuration for async lifecycle notifications.metadata: Optional object stored with the batch.
Use exactly one input source per batch: prompts, items, requests, or input_file_id.
Returns
BatchResponse
Batch responses also surface gateway observability fields such as request_id, provider, echoed session_id / webhook, and terminal billing / pricing_lines when available.
Use client.batch_websocket_url(...) when you want to subscribe to the documented /v1/async/batch/{id}/ws lifecycle stream instead of polling only.
Use client.async_jobs.websocket_url("batch", batch["id"], ...) when you want the generic async-jobs resource helper.
Use client.get_async_job_websocket_url("batch", batch["id"], ...) when you want the same generic helper without going through the resource object. Last modified on July 26, 2026
