SAsailresearch
Batches API

Get batch request result

Changed on

Retrieve the result of a specific request within a batch by its custom_id. Results can expire 10 minutes after first successful delivery.

get/batches/{batch_id}/{custom_id}

Request

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

Path parameters

batch_idstring required

The ID of the batch.

custom_idstring required

The custom_id of the request within the batch.

Response

The response object for the given request.

idstring required
object'response' required
created_atinteger required
status'queued' | 'in_progress' | 'failed' | 'completed' | 'incomplete' | 'cancelled' required
modelstring required
errorobject nullable
incomplete_detailsobject nullable
max_output_tokensinteger nullable
reasoningobject
storeboolean
temperaturenumber
top_pnumber
parallel_tool_callsboolean
toolsobject[]
userstring nullable
service_tier'asap' | 'balanced' | 'flex'

The completion window Sail selected for this request, including when no window was requested. The legacy request value standard is reported as balanced. Older stored responses may omit this field.

Changes

  • d63ac1749ae7Revision changes
    • breaking

      added to the ///////// response property oneOf list for the response status

    • breaking

      added to the ///// response property oneOf list for the response status

    • breaking

      added subschema #2 to the response property oneOf list for the response status

    • breaking

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

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      added the new in_progress enum value to the response property for the response status

    • warning

      added the new incomplete 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

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status

    • info

      removed the pending enum value from the response property for the response status

    • info

      removed the running enum value from the response property for the response status