Skip to main content
GET
/
v1
/
batches
/
{batch_id}
Get batch details
curl --request GET \
  --url https://sdk.nimbleway.com/v1/batches/{batch_id} \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "id": "string",
  "completed": true,
  "completed_count": 1,
  "progress": 1,
  "created_at": "string",
  "completed_at": "string",
  "tasks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "state": "pending",
      "output_url": "string",
      "status_url": "https://sdk.nimbleway.com/api/v2/tasks/123e4567-e89b-12d3-a456-426614174000",
      "download_url": "https://sdk.nimbleway.com/api/v2/tasks/123e4567-e89b-12d3-a456-426614174000/results",
      "error": "Connection timeout",
      "error_type": "timeout_error",
      "created_at": "2024-01-15T10:30:00Z",
      "modified_at": "2024-01-15T10:35:00Z",
      "account_name": "string",
      "input": null,
      "_query": null,
      "batch_id": "4b0a90bf-c951-42e4-95b3-a95a65ba69fc",
      "status_code": 200,
      "api_type": "web"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
batch_id
string
required

The unique identifier of the batch.

Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

Batch found and returned successfully.

Response containing batch details with all tasks.

​
status
string
required
Allowed value: "success"
​
id
string
required

Unique identifier for the batch.

​
completed
boolean
required

Whether all tasks in the batch have finished.

​
completed_count
number
required

Number of tasks that have completed so far.

​
progress
number
required

Completion ratio between 0 and 1.

​
created_at
string
required

ISO timestamp when the batch was created.

​
tasks
(object | null)[]
required

List of tasks in the batch.

​
completed_at
string

ISO timestamp when the batch completed.