Overview
This API is used to query the information of a specified batch task. It behaves similarly to the GET method and is compatible with callers who prefer to use the POST method to query tasks. 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
POST {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 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 resource |
| name | string | Resource name |
| status | string | Resource status |
| createTime | string | Creation time |
Request example
curl --request POST '{BASE_URL}/api/v1/batches/{batch_id}' \
--header 'Authorization: Bearer YOUR_API_KEY'
Response example
{
"success": true,
"code": "200",
"message": "successful",
"data": {
"id": "r-123456",
"name": "demo-name",
"status": "RUNNING",
"createTime": "2026-04-10T10:00:00Z"
}
}