Overview
This API is used to query the status and file information of a specified batch task. By providing the unique identifier of the batch task, you can obtain its current execution status and related file details. Currently, this API is supported only by Alibaba Cloud's Qwen series of models.
API details
Constraints
- You must have an API key. For more information, see Manage AI API keys.
Request path
GET {BASE_URL}/api/v1/batches/{batch_id}
Request header
Name |
Required |
Example value |
Description |
|---|---|---|---|
| Authorization | Yes | Bearer YOUR_API_KEY | Authentication information |
| Content-Type | No | application/json | Request body format |
Request parameters
Path
Name |
Type |
Required |
Example value |
Description |
|---|---|---|---|---|
| batch_id | string | Yes | batch_abc123 | Batch Task ID |
Query
None
Body
None
Response
Response parameters
Name |
Type |
Description |
|---|---|---|
| success | boolean | Whether the request was successful |
| code | string | Response code |
| message | string | Response message. |
| data | object | Response data. |
data
Name |
Type |
Description |
|---|---|---|
| id | string | Unique ID of the batch task |
| status | string | Batch task status |
| fileInfo | object | Associated file information |
Request example
curl --request GET '{BASE_URL}/api/v1/batches/batch_abc123' \
--header 'Authorization: Bearer YOUR_API_KEY'
Response example
{
"success": true,
"code": "200",
"message": "successful",
"data": {
"id": "batch_abc123",
"status": "completed",
"fileInfo": {
"id": "file-xyz789",
"filename": "output.jsonl"
}
}
}