For the batch lifecycle and best practices, see the Batch Processing Guide. This page is the Python SDK reference. HITL checkpoints are not available for batches - use individual
deepresearch.create() tasks for those.Run a batch of DeepResearch tasks in parallel with the Python SDK.
Quick start
create_and_run() creates a batch, adds tasks, and (with wait=True) blocks until everything finishes:
create() then add_tasks(), and wait_for_completion() to block.
Reference
Methods
Methods
| Method | Description |
|---|---|
create(name, mode, output_formats, search, webhook_url, metadata) | Create an empty batch container |
add_tasks(batch_id, tasks) | Add 1-100 tasks (dicts or BatchTaskInput). Batch must be open or processing |
create_and_run(tasks, wait=False, ...) | Create + add tasks in one call, optionally waiting for completion |
status(batch_id) | Current status, task counts, and cost |
list_tasks(batch_id, status=None, include_output=False, limit=25, last_key=None) | List tasks; set include_output=True for full output, sources, images, cost |
wait_for_completion(batch_id, poll_interval=10, max_wait_time=14400, on_progress=None) | Block until terminal state. Raises TimeoutError / ValueError |
cancel(batch_id) | Cancel the batch and its pending tasks |
list(limit=10) | List batches for your account |
mode, output_formats, and search are inherited by every task and cannot be overridden per-task. Per-task you can set research_strategy, report_format, urls, and metadata.Search configuration
Search configuration
The batch-level See the Batch Processing Guide for all options.
search config (dict or SearchConfig) applies to all tasks:Task input and listing results
Task input and listing results
Response types
Response types
Webhooks
Passwebhook_url on create() to be notified when the batch reaches a terminal state (completed, completed_with_errors, or cancelled) instead of polling. The webhook_secret is returned only on creation - store it immediately.
Limitations
| Constraint | Value |
|---|---|
| Tasks per request | 1-100 |
| Batch status to add tasks | open or processing |
See also
Batch Processing Guide
Lifecycle, best practices, and examples
DeepResearch API
Individual task API with all features
TypeScript SDK
TypeScript batch methods
API Reference
REST endpoint documentation

