Retrieve batch results

Use this method to retrieve the results for each item in a batch. You can call it while the batch has the pending or processing status.

Each result entry has a status. For details on each status, see the Item statuses section on the The batch object page.

Each result entry includes a task identifier in the task_id field. Use this value with the GET method of the /analyze/tasks/{task_id} endpoint if you need the full analysis task response.

You can retrieve results for 30 days after batch creation.

Use this method to retrieve the results for each item in a batch. You can call it while the batch has the `pending` or `processing` status. Each result entry has a status. For details on each status, see the [Item statuses](/v1.3/api-reference/analyze-videos/batch-analysis/the-batch-object#item-statuses) section on the **The batch object** page. Each result entry includes a task identifier in the `task_id` field. Use this value with the [`GET`](/v1.3/api-reference/analyze-videos/retrieve-analysis-task-status-results) method of the `/analyze/tasks/{task_id}` endpoint if you need the full analysis task response. You can retrieve results for 30 days after batch creation.

Authentication

x-api-keystring

Your API key.

Note

You can find your API key on the API Keys page.

Your API key. <Note title="Note"> You can find your API key on the <a href="https://playground.twelvelabs.io/dashboard/api-keys" target="_blank">API Keys</a> page. </Note>

Path parameters

batch_idstringRequiredformat: "^[0-9a-fA-F]{24}$"

The unique identifier of the batch.

Response

The response is a JSON Lines (application/jsonl) stream. Each line is a JSON object containing one result entry for a batch item.

Example body with four result entries:

1 {"task_id":"68f4ddaf8aaa60d33df0e900","custom_id":"summary-001","status":"ready","data":{"generation_id":"gen_xyz789","data":"This video covers the keynote launch...","finish_reason":"stop","usage":{"output_tokens":150,"input_tokens":45}}}
2 {"task_id":"68f4ddaf8aaa60d33df0e901","custom_id":"summary-002","status":"failed","error":{"code":"asset_unavailable","message":"The asset could not be read."}}
3 {"task_id":"68f4ddaf8aaa60d33df0e902","custom_id":"summary-003","status":"processing"}
4 {"task_id":"68f4ddaf8aaa60d33df0e903","custom_id":"summary-004","status":"queued"}

The response is a JSON Lines (`application/jsonl`) stream. Each line is a JSON object containing one result entry for a batch item. Example body with four result entries: ```jsonl {"task_id":"68f4ddaf8aaa60d33df0e900","custom_id":"summary-001","status":"ready","data":{"generation_id":"gen_xyz789","data":"This video covers the keynote launch...","finish_reason":"stop","usage":{"output_tokens":150,"input_tokens":45}}} {"task_id":"68f4ddaf8aaa60d33df0e901","custom_id":"summary-002","status":"failed","error":{"code":"asset_unavailable","message":"The asset could not be read."}} {"task_id":"68f4ddaf8aaa60d33df0e902","custom_id":"summary-003","status":"processing"} {"task_id":"68f4ddaf8aaa60d33df0e903","custom_id":"summary-004","status":"queued"} ```

task_idstring

The unique task identifier generated by the platform for this item.

custom_idstring or null

The custom identifier you provided when you created the batch. If you did not provide one, this field is null.

statusenum

The status of a result entry. This field is different from the batch status. For the meaning of each value, see the Item statuses section on the The batch object page.

dataobject

Contains the analysis result for an item in the ready status. The analysis text is in this object’s nested data field. The envelope uses the same schema as the result field in the GET method of the /analyze/tasks/{task_id} endpoint.

errorobject

Failure details for a single batch item.

Errors

404

Not Found Error

1	{
2	"task_id": "68f4ddaf8aaa60d33df0e900",
3	"custom_id": "summary-001",
4	"status": "ready",
5	"data": {
6	"generation_id": "gen_xyz789",
7	"data": "This video covers the keynote launch of the new product line...",
8	"finish_reason": "stop",
9	"usage": {
10	"output_tokens": 150,
11	"input_tokens": 45
12	}
13	}
14	}

1	{"task_id":"68f4ddaf8aaa60d33df0e900","custom_id":"summary-001","status":"ready","data":{"generation_id":"gen_xyz789","data":"This video covers the keynote launch...","finish_reason":"stop","usage":{"output_tokens":150,"input_tokens":45}}}
2	{"task_id":"68f4ddaf8aaa60d33df0e901","custom_id":"summary-002","status":"failed","error":{"code":"asset_unavailable","message":"The asset could not be read."}}
3	{"task_id":"68f4ddaf8aaa60d33df0e902","custom_id":"summary-003","status":"processing"}
4	{"task_id":"68f4ddaf8aaa60d33df0e903","custom_id":"summary-004","status":"queued"}