External API docs

Check batch status

Poll the batch status endpoint until the batch reports ready, then fetch task IDs and task results.

Endpoint

Route
GET https://api.openmart.ai/api/v1/task/batch/:batch_id/status

Use this endpoint to check whether a batch is still processing or ready to read results. Keep polling until batch_ready becomes true.

Parameters

Parameter
batch_id
Type
string
Required
Yes
Example
"5dbca0d5..."
Description
The batch ID returned when you submit a batch enrichment request.

cURL request

cURL
curl --request GET \
  --url https://api.openmart.ai/api/v1/task/batch/<batch_id>/status \
  --header 'Accept: application/json' \
  --header 'X-API-Key: <your_api_key>'

Response example

JSON
{
  "processing": 0,
  "completed": 1,
  "errored": 0,
  "total": 1,
  "batch_ready": true
}
# Check Batch Status

## Endpoint

GET https://api.openmart.ai/api/v1/task/batch/:batch_id/status

## Description

Poll aggregate progress for a batch until `batch_ready` becomes true.

## Authentication

Header: `X-API-Key: <your_api_key>`

## Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| batch_id | string (path) | Yes | The batch ID returned when you submit a batch request. |

## Example Request

```bash
curl -X GET "https://api.openmart.ai/api/v1/task/batch/<batch_id>/status" \
  -H "Accept: application/json" \
  -H "X-API-Key: <your_api_key>"
```

## Example Response

```json
{
  "processing": 0,
  "completed": 1,
  "errored": 0,
  "total": 1,
  "batch_ready": true
}
```