List batches

⚠️
Preview — this feature is being built; the design below is the spec.
GET https://app.syntic.ai/v1/batches

Return the workspace’s batches, newest first.

For how this fits into a full workflow, see Batches.

Headers

HeaderRequiredValue
AuthorizationYesBearer <key>: a private inference key (sk_live_...). See Authentication.

Query parameters

ParameterTypeDefaultDescription
limitinteger201 to 100.
after_idstringNext page: the previous page’s last_id.
before_idstringPrevious page.
statusstringOnly batches in this status.

Response

200 OK, Content-Type: application/json

{
  "data": [
    {
      "id": "batch_01JBXF3P8K",
      "object": "batch",
      "status": "in_progress",
      "input_file_id": "file_01JBXF1Z",
      "output_file_id": null,
      "error_file_id": null,
      "request_counts": {
        "total": 5000,
        "succeeded": 3120,
        "failed": 4,
        "canceled": 0
      },
      "created_at": 1791820800,
      "started_at": 1791820860,
      "ends_by": 1791907200,
      "completed_at": null,
      "metadata": {
        "job": "october-tickets"
      }
    }
  ],
  "has_more": false,
  "first_id": "batch_01JBXF3P8K",
  "last_id": "batch_01JBXF3P8K"
}

Examples

curl -sS "https://app.syntic.ai/v1/batches?limit=10" \
  -H "Authorization: Bearer $SYNTIC_API_KEY"

Errors

Errors use the error envelope and carry a request_id. Codes specific to this operation:

StatustypecodeWhen
400invalid_request_errorinvalid_parameterlimit outside 1 to 100, or an unknown status.
401authentication_errorinvalid_api_keyThe key is missing, unknown, revoked or expired.
429rate_limit_errorrate_limitedToo many requests; wait for Retry-After. See Rate-limit headers.
Was this page helpful?