Browse API docsCheck batch status
External API docs

Check batch status

Check a batch until it is ready, then retrieve its task IDs and 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.

Authentication. We recommend sending your API key as Authorization: Bearer <your_api_key>. If your current integration already uses X-API-Key: <your_api_key>, it will continue to work.

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 'Authorization: Bearer <your_api_key>'

Response example

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

If this request fails

Match the error number or message in the response, then use the action below.

Error 400 / 422“... is required” or another field error
Read the error or detail field, then fix the named input.
Error 401“Invalid API Key”
Check the complete key and authentication header.
Error 402“Credit limit reached”
Check the team balance before trying again.
Error 403“Forbidden” or “not allowed”
Check whether this key and account can use the action.
Error 404“Not Found”
Check the API address, version, and GET, POST, or DELETE method.
Error 429“Too many requests”
Wait, then retry with fewer requests running at once.
Error 500–504Server error or timeout
Wait briefly and retry. Avoid duplicating an async job.

See Troubleshooting & FAQ for step-by-step help and the information to include when asking for support.