Batches

Get batch details

Retrieve the details of a batch including all its tasks and completion status.

get/v1/batches/{batch_id}

Path parameters

batch_idstring required

The unique identifier of the batch.

Example:123e4567-e89b-12d3-a456-426614174000

The unique identifier of the batch.

Response

Batch found and returned successfully.

completedboolean required

Whether all tasks in the batch have finished.

completed_atstring

ISO timestamp when the batch completed.

completed_countnumber required

Number of tasks that have completed so far.

created_atstring required

ISO timestamp when the batch was created.

idstring required

Unique identifier for the batch.

progressnumber required

Completion ratio between 0 and 1.

status'success' required

Example response

{
  "tasks": [
    {
      "batch_id": "4b0a90bf-c951-42e4-95b3-a95a65ba69fc",
      "created_at": "2024-01-15T10:30:00Z",
      "download_url": "https://api.webit.live/api/v2/tasks/123e4567-e89b-12d3-a456-426614174000/results",
      "error": "Connection timeout",
      "error_type": "timeout_error",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "modified_at": "2024-01-15T10:35:00Z",
      "state": "pending",
      "status_code": 200,
      "status_url": "https://api.webit.live/api/v2/tasks/123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Changes

Changed in 4 of the 55 revisions of this API.542

Jul 12, 2026e8a97dc9fce25See the full diff
- ▲
  response property tasks/items/anyOf[subschema #1]/batch_id list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property tasks/items/anyOf[subschema #1]/download_url list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property tasks/items/anyOf[subschema #1]/error list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property tasks/items/anyOf[subschema #1]/error_type list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property tasks/items/anyOf[subschema #1]/output_url list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
This revision also has 39 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 7, 2026ebe52c375b7131See the full diff
- ●
  added the new in_progress enum value to the tasks/items/anyOf[subschema #1]/state response property for the response status 200
  response-property-enum-value-added
- ●
  added the new labs enum value to the tasks/items/anyOf[subschema #1]/api_type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new queued enum value to the tasks/items/anyOf[subschema #1]/state response property for the response status 200
  response-property-enum-value-added
- ○
  added the optional property tasks/items/anyOf[subschema #1]/queue to the response with the 200 status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 10, 2026421a9851d61b1See the full diff
- ●
  added the new fast-serp enum value to the tasks/items/anyOf[subschema #1]/api_type response property for the response status 200
  response-property-enum-value-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 24, 202649cd7a10eca51See the full diff
- ○
  endpoint added
  endpoint-added

Full history