Start a batch over Library pictures
start_batchRun the same model, scene and options once for each of several pictures in the account’s Library — for example image to 3D for twelve product photos. Take the scenes and models from list_models (batches), and each picture’s asset_id from get_job or search_library on a finished image job. Nothing is charged now: each run is charged as it starts and refunded if it fails, but the balance must cover the whole quote, and for a key or connection with a monthly limit the whole quote is held against it until each picture runs (then its real cost counts) or is cancelled, refused or refunded (then nothing does). Returns a batch id at once; follow it with get_batch. Pass idempotency_key on retries so a repeat returns the same batch instead of queueing another.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| items | Yes | One entry per picture: a Library image’s asset_id. | |
| model | Yes | ||
| scene | Yes | ||
| prompt | No | ||
| options | No | Options every run shares, as for generate; the picture field is filled per item. | |
| project_id | No | ||
| idempotency_key | No | ||
| notify_by_email | No | ||
| expected_credits | No | The quote you showed the person; a different price queues nothing. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| items | Yes | ||
| model | Yes | ||
| scene | Yes | ||
| counts | Yes | ||
| reused | Yes | An earlier call with this idempotency_key started it. | |
| status | Yes | ||
| balance | Yes | Credits available when it was accepted. | |
| batch_id | Yes | ||
| created_at | Yes | ||
| item_count | Yes | ||
| settled_at | Yes | ||
| quoted_credits | Yes | What the batch costs if every picture runs. | |
| charged_credits | Yes | What its runs were charged so far. | |
| per_item_credits | Yes |