External API docs

Get task IDs in a batch

After a batch is ready, fetch task IDs for completed tasks so you can retrieve final task results.

Endpoint

Route
GET https://api.openmart.ai/api/v1/task/batch/:batch_id/task_ids?status=COMPLETED

Use this endpoint after batch_ready is true. Replace <batch_id> with your batch ID.

Parameters

Parameter
batch_id
Type
string
Required
Yes
Example
"183219bc..."
Description
The batch ID returned when you submit a batch request.
Parameter
status
Type
string
Required
No
Example
"COMPLETED"
Description
Optional status filter for returned task IDs (for example COMPLETED).

cURL request

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

Response example

JSON
[
  "2fc8b627-1111-2222-3333-123456789abc"
]
# Get Task IDs in a Batch

## Endpoint

GET https://api.openmart.ai/api/v1/task/batch/:batch_id/task_ids?status=COMPLETED

## Description

After a batch is ready, fetch task IDs for completed tasks so you can retrieve final task results.

## 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. |
| status | string (query) | No | Optional status filter (e.g. COMPLETED). |

## Example Request

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

## Example Response

```json
[
  "2fc8b627-1111-2222-3333-123456789abc"
]
```