SAsailresearch
Batches API

Create a batch

Submit a batch of requests for asynchronous processing. Each item only supports metadata.completion_window: "flex", which is also the default when omitted or empty. See the Batch API guide.

post/batches

Request

  • Base URL
    https://api.sailresearch.com/v1
  • URL
    https://api.sailresearch.com/v1/batches
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring

Identifies one submission within your organization and API key. Reuse the same value and request body when retrying; use a new value for new work. See Idempotency.

Request body

endpoint'/v1/responses' required

The API endpoint to use for all requests in the batch. Currently only /v1/responses is supported.

labelstring

An optional label for the batch. Must be alphanumeric (hyphens and underscores allowed), max 128 characters.

Response

Batch created.

idstring required

Unique identifier for the batch.

request_countsinteger required

Total number of requests in the batch.

created_atinteger required

Unix timestamp of when the batch was created.

labelstring

The label for the batch, if provided.

Changes

No recorded changes to this operation across all 2 revisions of this API.