Create a batch job

Opens an empty batch job. Items arrive on later upload calls and the set
is sealed at finalize.

Supplying request_id makes the create idempotent on that token: a
retried submit whose response was lost returns the original job rather
than opening a second one. This dedupe is scoped to the calling
credential. A request_id whose job was canceled or failed before it
finalized is released for a fresh replay; once a job is finalized, its
request_id keeps resolving to it even after cancellation.

An instance may hold at most 4 active (pending or processing) jobs at
once; a create past that limit returns 409. The limit is instance-wide
— jobs are shared across the instance's credentials — so another
credential's jobs count against it.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Body of a create-batch request. Opens an empty job.

string

Optional client idempotency token. A retried create with the same
token returns the original job instead of opening a second one.

Responses

400

Invalid request (e.g. request_id over its 256-byte limit)

401

Unauthorized

409

The instance is at its 4-job active-batch limit; wait for one to finish

499

Client closed request before response was ready

500

Server error

504

Request timed out

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json