SAsailresearch
Batches API

Get batch status and results

Changed on

Poll for batch progress and read inline results once all requests have finished. See Reading the batch response for result handling and Large batches and individual results for limits and retries.

get/batches/{batch_id}

Request

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

Path parameters

batch_idstring required

Response

Batch status and counts, with inline results when complete and within the inline size limit.

idstring required

Unique identifier for the batch.

object'batch' required
endpoint'/v1/responses' required

Endpoint used by the requests in this batch.

status'in_progress' | 'completed' required

Completed means every request has finished, including any that failed or were cancelled.

created_atinteger required

Unix timestamp of when the batch was created.

labelstring

The label for the batch, if provided.

request_statusobject required

Current statuses keyed by custom_id. Status updates may be partial; use the batch status field to decide when it is complete.

Changes

  • d63ac1749ae7Revision changes
    • breaking

      the response's property type changed from integer to object for status

    • warning

      added the new CANCELLED enum value to the // response property for the response status

    • warning

      added the new COMPLETED enum value to the // response property for the response status

    • warning

      added the new FAILED enum value to the // response property for the response status

    • warning

      added the new QUEUED enum value to the // response property for the response status

    • warning

      added the new RUNNING enum value to the // response property for the response status

    • info

      added the non-success response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status