批处理API文档

[#](about:blank#%E6%89%B9%E5%A4%84%E7%90%86api%E6%96%87%E6%A1%A3) [#](about:blank#%E6%98%9F%E7%81%AB%E5%A4%A7%E6%A8%A1%E5%9E%8B%E6%89%B9%E5%A4%84%E7%90%86api%E6%96%87%E6%A1%A3) 批处理API文档
=========================================================================================================================================================================================

[#](about:blank#%E4%B8%80%E3%80%81%E6%9C%8D%E5%8A%A1%E4%BB%8B%E7%BB%8D) [#](about:blank#%E4%B8%80%E3%80%81%E6%9C%8D%E5%8A%A1%E4%BB%8B%E7%BB%8D) 一、服务介绍
------------------------------------------------------------------------------------------------------------------------------------------------------

**文件保存时间：** 上传的文件默认保存 30 天；接口返回的文件按照文件生成的时间开始计时，默认保存 30 天。  
**文件要求：**  
格式：只支持 jsonl 文件名后缀  
custom\_id：全文件不能存在重复  
method：只支持 POST  
url：只支持 /v1/chat/completions  
model：支持预置、精调、托管的文本生成类模型，取值为modelId

**注意：每个请求一行，单个文件不超过5万行；body 中 model 全文件保持相同；调用精调大模型时patch_id必传**  
**文件单行示例：**

```
{"custom_id": "request-1", "method": "POST", "url": "/v1/chat/completions", "body": {"model": "xop1ef199ca", "messages": [{"role": "system", "content": "You are a helpful assistant."},{"role": "user", "content": "1+1=?"}],"max_tokens":2048,"top_k":4,"temperature":0.5,"patch_id":["0"]}}

```

[#](about:blank#%E4%BA%8C%E3%80%81%E6%8E%A5%E5%8F%A3-demo) [#](about:blank#%E4%BA%8C%E3%80%81%E6%8E%A5%E5%8F%A3-demo) 二、接口 Demo
-------------------------------------------------------------------------------------------------------------------------------

部分开发语言Demo如下，其他开发语言请参照文档进行开发。在使用demo之前，请修改代码中的APIPassword以及patch_id（调用精调大模型时必传）  
[批处理API-Demo-Java (opens new window) (opens new window)](https://openres.xfyun.cn/xfyundoc/2024-10-15/56b6b6b2-547a-4ab6-afb2-c4712df48815/1728991787664/BatchAPI-Java.zip)  
[批处理API-Demo-Python (opens new window) (opens new window)](https://openres.xfyun.cn/xfyundoc/2025-06-16/48915c51-2582-457f-bdeb-8b15e91fd90c/1750067679158/batch_demo.zip)

[#](about:blank#%E4%B8%89%E3%80%81%E6%8E%A5%E5%8F%A3%E5%88%97%E8%A1%A8) [#](about:blank#%E4%B8%89%E3%80%81%E6%8E%A5%E5%8F%A3%E5%88%97%E8%A1%A8) 三、接口列表
------------------------------------------------------------------------------------------------------------------------------------------------------

### [#](about:blank#%E6%8E%A5%E5%8F%A3%E9%89%B4%E6%9D%83) [#](about:blank#%E6%8E%A5%E5%8F%A3%E9%89%B4%E6%9D%83) 接口鉴权

请先获取http服务接口认证信息中的APIPassword，假如获取到的值为123456，则请求头如下：

```
Authorization: Bearer 123456

```

### [#](about:blank#_3-1%E3%80%81%E4%B8%8A%E4%BC%A0%E6%96%87%E4%BB%B6) [#](about:blank#_3-1%E3%80%81%E4%B8%8A%E4%BC%A0%E6%96%87%E4%BB%B6) 3.1、上传文件

#### [#](about:blank#%E6%8E%A5%E5%8F%A3%E6%8F%8F%E8%BF%B0) [#](about:blank#%E6%8E%A5%E5%8F%A3%E6%8F%8F%E8%BF%B0) 接口描述

上传jsonl文件，文件格式需要符合要求（具体可参考 一、服务介绍），上传的文件默认保存 30 天。

#### [#](about:blank#%E6%8E%A5%E5%8F%A3%E5%9C%B0%E5%9D%80) [#](about:blank#%E6%8E%A5%E5%8F%A3%E5%9C%B0%E5%9D%80) 接口地址

```
POST   https://spark-api-open.xf-yun.com/v1/files

```

#### [#](about:blank#%E8%AF%B7%E6%B1%82%E5%A4%B4) [#](about:blank#%E8%AF%B7%E6%B1%82%E5%A4%B4) 请求头

```
Authorization: Bearer $APIPassword
Content-Type: multipart/form-data

```

#### [#](about:blank#%E8%AF%B7%E6%B1%82%E4%BD%93) [#](about:blank#%E8%AF%B7%E6%B1%82%E4%BD%93) 请求体

| 字段名 | 类型 | 是否必传 | 描述 |
| --- | --- | --- | --- |
| purpose | string | 是 | 传 batch，表示上传文件的意图 |
| file | file | 是 | 文件（最大不超过 100 MB，默认保存30天） |

#### [#](about:blank#%E5%93%8D%E5%BA%94%E5%8F%82%E6%95%B0%E8%AF%B4%E6%98%8E) [#](about:blank#%E5%93%8D%E5%BA%94%E5%8F%82%E6%95%B0%E8%AF%B4%E6%98%8E) 响应参数说明

| 字段名 | 类型 | 描述 |
| --- | --- | --- |
| id | string | 文件唯一标识符（全局唯一） |
| 格式为：file\_xxxxx |  |  |
| object | string | 上传类型(扩展字段，当前仅为 file) |
| bytes | int | 文件长度(单位：Byte) |
| created\_at | int | 文件创建时间 |
| filename | string | 文件名 |
| purpose | string | 上传文件的意图(请求参数传入值) |

#### [#](about:blank#%E5%93%8D%E5%BA%94%E5%8F%82%E6%95%B0%E7%A4%BA%E4%BE%8B) [#](about:blank#%E5%93%8D%E5%BA%94%E5%8F%82%E6%95%B0%E7%A4%BA%E4%BE%8B) 响应参数示例

```
{
  "id": "file-abc123",
  "object": "file",
  "bytes": 120000,
  "created_at": 1677610602,
  "filename": "mydata.jsonl",
  "purpose": "batch"
}

```

### [#](about:blank#_3-2%E3%80%81%E6%9F%A5%E8%AF%A2%E6%96%87%E4%BB%B6%E5%88%97%E8%A1%A8) [#](about:blank#_3-2%E3%80%81%E6%9F%A5%E8%AF%A2%E6%96%87%E4%BB%B6%E5%88%97%E8%A1%A8) 3.2、查询文件列表

#### [#](about:blank#%E6%8E%A5%E5%8F%A3%E6%8F%8F%E8%BF%B0-2) [#](about:blank#%E6%8E%A5%E5%8F%A3%E6%8F%8F%E8%BF%B0-2) 接口描述

获取 appid 下的文件列表。 上传的文件默认保存 30 天；接口返回的文件按照文件生成的时间开始计时，默认保存 30 天。

#### [#](about:blank#%E6%8E%A5%E5%8F%A3%E5%9C%B0%E5%9D%80-2) [#](about:blank#%E6%8E%A5%E5%8F%A3%E5%9C%B0%E5%9D%80-2) 接口地址

```
GET   https://spark-api-open.xf-yun.com/v1/files?page=1&size=20

```

按创建时间排序，获取 \[(page-1) 20 + 1, (page-1) 20 + size\] 的数据

#### [#](about:blank#%E8%AF%B7%E6%B1%82%E5%A4%B4-2) [#](about:blank#%E8%AF%B7%E6%B1%82%E5%A4%B4-2) 请求头

```
Authorization: Bearer $APIPassword

```

#### [#](about:blank#%E5%93%8D%E5%BA%94%E5%8F%82%E6%95%B0%E7%A4%BA%E4%BE%8B-2) [#](about:blank#%E5%93%8D%E5%BA%94%E5%8F%82%E6%95%B0%E7%A4%BA%E4%BE%8B-2) 响应参数示例

```
{
  "data": [
    {
      "id": "file-abc123",
      "object": "file",
      "bytes": 175,
      "created_at": 1613677385,
      "filename": "mydata.jsonl",
      "purpose": "batch"
    },
    {
      "id": "file-abc123",
      "object": "file",
      "bytes": 140,
      "created_at": 1613779121,
      "filename": "puppy.jsonl",
      "purpose": "batch"
    }
  ],
  "object": "list"
}

```

### [#](about:blank#_3-3%E3%80%81%E6%9F%A5%E8%AF%A2%E5%8D%95%E4%B8%AA%E6%96%87%E4%BB%B6) [#](about:blank#_3-3%E3%80%81%E6%9F%A5%E8%AF%A2%E5%8D%95%E4%B8%AA%E6%96%87%E4%BB%B6) 3.3、查询单个文件

#### [#](about:blank#%E6%8E%A5%E5%8F%A3%E6%8F%8F%E8%BF%B0-3) [#](about:blank#%E6%8E%A5%E5%8F%A3%E6%8F%8F%E8%BF%B0-3) 接口描述

根据文件的file\_id获取该文件信息。 上传的文件默认保存 30 天；接口返回的文件按照文件生成的时间开始计时，默认保存 30 天。

#### [#](about:blank#%E6%8E%A5%E5%8F%A3%E5%9C%B0%E5%9D%80-3) [#](about:blank#%E6%8E%A5%E5%8F%A3%E5%9C%B0%E5%9D%80-3) 接口地址

```
GET   https://spark-api-open.xf-yun.com/v1/files/{file_id}

```

**注意：请求参数file\_id放在路径中！**

#### [#](about:blank#%E8%AF%B7%E6%B1%82%E5%A4%B4-3) [#](about:blank#%E8%AF%B7%E6%B1%82%E5%A4%B4-3) 请求头

```
Authorization: Bearer $APIPassword

```

#### [#](about:blank#%E5%93%8D%E5%BA%94%E5%8F%82%E6%95%B0%E7%A4%BA%E4%BE%8B-3) [#](about:blank#%E5%93%8D%E5%BA%94%E5%8F%82%E6%95%B0%E7%A4%BA%E4%BE%8B-3) 响应参数示例

```
{
  "id": "file-abc123",
  "object": "file",
  "bytes": 120000,
  "created_at": 1677610602,
  "filename": "mydata.jsonl",
  "purpose": "batch"
}

```

### [#](about:blank#_3-4%E3%80%81%E5%88%A0%E9%99%A4%E6%96%87%E4%BB%B6) [#](about:blank#_3-4%E3%80%81%E5%88%A0%E9%99%A4%E6%96%87%E4%BB%B6) 3.4、删除文件

#### [#](about:blank#%E6%8E%A5%E5%8F%A3%E6%8F%8F%E8%BF%B0-4) [#](about:blank#%E6%8E%A5%E5%8F%A3%E6%8F%8F%E8%BF%B0-4) 接口描述

根据文件的file\_id删除该文件

#### [#](about:blank#%E6%8E%A5%E5%8F%A3%E5%9C%B0%E5%9D%80-4) [#](about:blank#%E6%8E%A5%E5%8F%A3%E5%9C%B0%E5%9D%80-4) 接口地址

```
DELETE   https://spark-api-open.xf-yun.com/v1/files/{file_id}

```

**注意：请求参数file\_id放在路径中！**

#### [#](about:blank#%E8%AF%B7%E6%B1%82%E5%A4%B4-4) [#](about:blank#%E8%AF%B7%E6%B1%82%E5%A4%B4-4) 请求头

```
Authorization: Bearer $APIPassword

```

#### [#](about:blank#%E5%93%8D%E5%BA%94%E5%8F%82%E6%95%B0%E7%A4%BA%E4%BE%8B-4) [#](about:blank#%E5%93%8D%E5%BA%94%E5%8F%82%E6%95%B0%E7%A4%BA%E4%BE%8B-4) 响应参数示例

```
{
  "id": "file-abc123",
  "object": "file",
  "deleted": true
}

```

### [#](about:blank#_3-5%E3%80%81%E4%B8%8B%E8%BD%BD%E6%96%87%E4%BB%B6) [#](about:blank#_3-5%E3%80%81%E4%B8%8B%E8%BD%BD%E6%96%87%E4%BB%B6) 3.5、下载文件

#### [#](about:blank#%E6%8E%A5%E5%8F%A3%E6%8F%8F%E8%BF%B0-5) [#](about:blank#%E6%8E%A5%E5%8F%A3%E6%8F%8F%E8%BF%B0-5) 接口描述

根据文件的file\_id获取文件的详细内容。 上传的文件默认保存 30 天；接口返回的文件按照文件生成的时间开始计时，默认保存 30 天。

#### [#](about:blank#%E6%8E%A5%E5%8F%A3%E5%9C%B0%E5%9D%80-5) [#](about:blank#%E6%8E%A5%E5%8F%A3%E5%9C%B0%E5%9D%80-5) 接口地址

```
GET   https://spark-api-open.xf-yun.com/v1/files/{file_id}/content

```

**注意：请求参数file\_id放在路径中！**

#### [#](about:blank#%E8%AF%B7%E6%B1%82%E5%A4%B4-5) [#](about:blank#%E8%AF%B7%E6%B1%82%E5%A4%B4-5) 请求头

```
Authorization: Bearer $APIPassword

```

#### [#](about:blank#%E5%93%8D%E5%BA%94%E5%8F%82%E6%95%B0%E7%A4%BA%E4%BE%8B-5) [#](about:blank#%E5%93%8D%E5%BA%94%E5%8F%82%E6%95%B0%E7%A4%BA%E4%BE%8B-5) 响应参数示例

响应为文件的详细内容，可参考：

```
{"custom_id": "request-1", "method": "POST", "url": "/v1/chat/completions", "body": {"model": "xop1ef199ca", "messages": [{"role": "system", "content": "You are a helpful assistant."},{"role": "user", "content": "1+1=?"}],"max_tokens": 1000}}

```

### [#](about:blank#_3-6%E3%80%81%E5%88%9B%E5%BB%BAbatch%E4%BB%BB%E5%8A%A1) [#](about:blank#_3-6%E3%80%81%E5%88%9B%E5%BB%BAbatch%E4%BB%BB%E5%8A%A1) 3.6、创建Batch任务

#### [#](about:blank#%E6%8E%A5%E5%8F%A3%E6%8F%8F%E8%BF%B0-6) [#](about:blank#%E6%8E%A5%E5%8F%A3%E6%8F%8F%E8%BF%B0-6) 接口描述

调用该接口前需要先上传jsonl文件，通过上传文件得到的file\_id来创建Batch任务。 单个Batch任务最多包含5万个请求（一个请求对应jsonl文件的一行），每个请求的body不超过6KB

#### [#](about:blank#%E6%8E%A5%E5%8F%A3%E5%9C%B0%E5%9D%80-6) [#](about:blank#%E6%8E%A5%E5%8F%A3%E5%9C%B0%E5%9D%80-6) 接口地址

```
POST   https://spark-api-open.xf-yun.com/v1/batches

```

#### [#](about:blank#%E8%AF%B7%E6%B1%82%E5%A4%B4-6) [#](about:blank#%E8%AF%B7%E6%B1%82%E5%A4%B4-6) 请求头

```
Authorization: Bearer $APIPassword
Content-Type: application/json

```

#### [#](about:blank#%E8%AF%B7%E6%B1%82%E4%BD%93-2) [#](about:blank#%E8%AF%B7%E6%B1%82%E4%BD%93-2) 请求体

| 字段名 | 类型 | 是否必传 | 描述 |
| --- | --- | --- | --- |
| input\_file\_id | string | 是 | 文件标识符 （上传文件成功时返回的 file\_id） |
| 格式为：file\_xxxxx |  |  |  |
| endpoint | string | 是 | 处理批任务的服务的 path 路径 |
| 当前仅支持 /v1/chat/completions |  |  |  |
| completion\_window | string | 是 | 批处理任务完成的时间窗口 |
| 当前仅支持 24h，在此时间内完成，超时则不再处理，未处理任务视为失败 |  |  |  |
| metadata | Map<String, String> | 否 | 批任务附加信息，例如： |

"customer\_id": "user\_123456789"  
"batch\_description": "Sentiment classification" |

#### [#](about:blank#%E5%93%8D%E5%BA%94%E5%8F%82%E6%95%B0%E8%AF%B4%E6%98%8E-2) [#](about:blank#%E5%93%8D%E5%BA%94%E5%8F%82%E6%95%B0%E8%AF%B4%E6%98%8E-2) 响应参数说明

| 字段名 | 类型 | 描述 |
| --- | --- | --- |
| id | string | 批任务唯一标识（全局唯一） |
| 格式为：batch\_xxxxx |  |  |
| object | string | 结构类型，当前仅为 batch |
| endpoint | string | 处理批任务的服务的 path 路径，当前仅为 /v1/chat/completions |
| errors | object | 错误列表 |
| errors.object | string | 描述 data 类型 (list) |
| errors.data | array | \[{code string, message string, param string or null, line int or null}\] |
| input\_file\_id | string | 文件id（用户入参） |
| status | string | 任务状态（枚举值） |
| output\_file\_id | string | 结果文件id |
| error\_file\_id | string | 错误文件id |
| created\_at | int | 任务创建时间（unix时间戳，下面的时间也均为unix时间戳） |
| in\_progress\_at | int | 任务开始处理时间 |
| expires\_at | int | 任务预期超时时间 |
| finalizing\_at | int | 任务完成开始时间(写 out\_file && error\_file 开始) |
| completed\_at | int | 任务完成结束时间(写 out\_file && error\_file 结束) |
| failed\_at | int | 任务失败时间(所有任务失败时返回) |
| expired\_at | int | 任务实际超时时间 |
| cancelling\_at | int | 任务取消开始时间 （收到取消请求时间） |
| cancelled\_at | int | 任务取消结束时间 （任务实际取消时间） |
| request\_counts | object | 批任务信息 |
| request\_counts.total | int | 批任务当前完成总数 |
| request\_counts.completed | int | 任务当前成功数 |
| request\_counts.failed | int | 任务当前失败数 |
| metadata | object | 批任务附加信息（用户入参） |

#### [#](about:blank#status%E5%AD%97%E6%AE%B5%E8%AF%B4%E6%98%8E) [#](about:blank#status%E5%AD%97%E6%AE%B5%E8%AF%B4%E6%98%8E) status字段说明

| 枚举值 | 描述 |
| --- | --- |
| queuing | 排队 |
| failed | 处理失败 |
| in\_progress | 在处理 |
| finalizing | 上传中 |
| completed | 处理成功 |
| expired | 超时 |
| canceled | 已取消 |

#### [#](about:blank#%E5%93%8D%E5%BA%94%E5%8F%82%E6%95%B0%E7%A4%BA%E4%BE%8B-6) [#](about:blank#%E5%93%8D%E5%BA%94%E5%8F%82%E6%95%B0%E7%A4%BA%E4%BE%8B-6) 响应参数示例

```
{
  "id": "batch_abc123",
  "object": "batch",
  "endpoint": "/v1/completions",
  "errors": null,
  "input_file_id": "file-abc123",
  "completion_window": "24h",
  "status": "completed",
  "output_file_id": "file-cvaTdG",
  "error_file_id": "file-HOWS94",
  "created_at": 1711471533,
  "in_progress_at": 1711471538,
  "expires_at": 1711557933,
  "finalizing_at": 1711493133,
  "completed_at": 1711493163,
  "failed_at": null,
  "expired_at": null,
  "cancelling_at": null,
  "cancelled_at": null,
  "request_counts": {
    "total": 100,
    "completed": 95,
    "failed": 5
  },
  "metadata": {
    "customer_id": "user_123456789",
    "batch_description": "Sentiment classification"
  }
}

```

### [#](about:blank#_3-7%E3%80%81%E6%9F%A5%E8%AF%A2batch%E4%BB%BB%E5%8A%A1) [#](about:blank#_3-7%E3%80%81%E6%9F%A5%E8%AF%A2batch%E4%BB%BB%E5%8A%A1) 3.7、查询Batch任务

#### [#](about:blank#%E6%8E%A5%E5%8F%A3%E6%8F%8F%E8%BF%B0-7) [#](about:blank#%E6%8E%A5%E5%8F%A3%E6%8F%8F%E8%BF%B0-7) 接口描述

根据batch\_id获取该Batch任务的详细信息

#### [#](about:blank#%E6%8E%A5%E5%8F%A3%E5%9C%B0%E5%9D%80-7) [#](about:blank#%E6%8E%A5%E5%8F%A3%E5%9C%B0%E5%9D%80-7) 接口地址

```
GET   https://spark-api-open.xf-yun.com/v1/batches/{batch_id}

```

**注意：请求参数batch\_id放在路径中！**

#### [#](about:blank#%E8%AF%B7%E6%B1%82%E5%A4%B4-7) [#](about:blank#%E8%AF%B7%E6%B1%82%E5%A4%B4-7) 请求头

```
Authorization: Bearer $APIPassword
Content-Type: application/json

```

#### [#](about:blank#%E5%93%8D%E5%BA%94%E5%8F%82%E6%95%B0%E7%A4%BA%E4%BE%8B-7) [#](about:blank#%E5%93%8D%E5%BA%94%E5%8F%82%E6%95%B0%E7%A4%BA%E4%BE%8B-7) 响应参数示例

```
{
  "id": "batch_abc123",
  "object": "batch",
  "endpoint": "/v1/completions",
  "errors": null,
  "input_file_id": "file-abc123",
  "completion_window": "24h",
  "status": "completed",
  "output_file_id": "file-cvaTdG",
  "error_file_id": "file-HOWS94",
  "created_at": 1711471533,
  "in_progress_at": 1711471538,
  "expires_at": 1711557933,
  "finalizing_at": 1711493133,
  "completed_at": 1711493163,
  "failed_at": null,
  "expired_at": null,
  "cancelling_at": null,
  "cancelled_at": null,
  "request_counts": {
    "total": 100,
    "completed": 95,
    "failed": 5
  },
  "metadata": {
    "customer_id": "user_123456789",
    "batch_description": "Sentiment classification"
  }
}

```

### [#](about:blank#_3-8%E3%80%81%E5%8F%96%E6%B6%88batch%E4%BB%BB%E5%8A%A1) [#](about:blank#_3-8%E3%80%81%E5%8F%96%E6%B6%88batch%E4%BB%BB%E5%8A%A1) 3.8、取消Batch任务

#### [#](about:blank#%E6%8E%A5%E5%8F%A3%E6%8F%8F%E8%BF%B0-8) [#](about:blank#%E6%8E%A5%E5%8F%A3%E6%8F%8F%E8%BF%B0-8) 接口描述

根据batch\_id取消该Batch任务

#### [#](about:blank#%E6%8E%A5%E5%8F%A3%E5%9C%B0%E5%9D%80-8) [#](about:blank#%E6%8E%A5%E5%8F%A3%E5%9C%B0%E5%9D%80-8) 接口地址

```
GET   https://spark-api-open.xf-yun.com/v1/batches/{batch_id}/cancel

```

**注意：请求参数batch\_id放在路径中！**

#### [#](about:blank#%E8%AF%B7%E6%B1%82%E5%A4%B4-8) [#](about:blank#%E8%AF%B7%E6%B1%82%E5%A4%B4-8) 请求头

```
Authorization: Bearer $APIPassword
Content-Type: application/json

```

#### [#](about:blank#%E5%93%8D%E5%BA%94%E5%8F%82%E6%95%B0%E7%A4%BA%E4%BE%8B-8) [#](about:blank#%E5%93%8D%E5%BA%94%E5%8F%82%E6%95%B0%E7%A4%BA%E4%BE%8B-8) 响应参数示例

```
{
  "id": "batch_abc123",
  "object": "batch",
  "endpoint": "/v1/completions",
  "errors": null,
  "input_file_id": "file-abc123",
  "completion_window": "24h",
  "status": "completed",
  "output_file_id": "file-cvaTdG",
  "error_file_id": "file-HOWS94",
  "created_at": 1711471533,
  "in_progress_at": 1711471538,
  "expires_at": 1711557933,
  "finalizing_at": 1711493133,
  "completed_at": 1711493163,
  "failed_at": null,
  "expired_at": null,
  "cancelling_at": null,
  "cancelled_at": null,
  "request_counts": {
    "total": 100,
    "completed": 95,
    "failed": 5
  },
  "metadata": {
    "customer_id": "user_123456789",
    "batch_description": "Sentiment classification"
  }
}

```

### [#](about:blank#_3-9%E3%80%81%E6%9F%A5%E8%AF%A2batch%E5%88%97%E8%A1%A8) [#](about:blank#_3-9%E3%80%81%E6%9F%A5%E8%AF%A2batch%E5%88%97%E8%A1%A8) 3.9、查询Batch列表

#### [#](about:blank#%E6%8E%A5%E5%8F%A3%E6%8F%8F%E8%BF%B0-9) [#](about:blank#%E6%8E%A5%E5%8F%A3%E6%8F%8F%E8%BF%B0-9) 接口描述

获取 appid 下的Batch列表

#### [#](about:blank#%E6%8E%A5%E5%8F%A3%E5%9C%B0%E5%9D%80-9) [#](about:blank#%E6%8E%A5%E5%8F%A3%E5%9C%B0%E5%9D%80-9) 接口地址

```
GET   /v1/batches?limit=10&after={batch_id}

```

**注意：请求参数batch\_id放在路径中！**

| 字段名 | 类型 | 是否必传 | 描述 |
| --- | --- | --- | --- |
| limit | int | 否，默认为10 | 响应中列表长度（最大为100） |
| after | string | 否，默认从批任务创建时间正序排序开始查询 | 从此 batch\_id 开始查询（响应中不包括此 batch\_id） |

#### [#](about:blank#%E8%AF%B7%E6%B1%82%E5%A4%B4-9) [#](about:blank#%E8%AF%B7%E6%B1%82%E5%A4%B4-9) 请求头

```
Authorization: Bearer $APIPassword
Content-Type: application/json

```

#### [#](about:blank#%E5%93%8D%E5%BA%94%E5%8F%82%E6%95%B0%E7%A4%BA%E4%BE%8B-9) [#](about:blank#%E5%93%8D%E5%BA%94%E5%8F%82%E6%95%B0%E7%A4%BA%E4%BE%8B-9) 响应参数示例

```
{
  "object": "list",
  "data": [
    {
      "id": "batch_abc123",
      "object": "batch",
      "endpoint": "/v1/chat/completions",
      "errors": null,
      "input_file_id": "file-abc123",
      "completion_window": "24h",
      "status": "completed",
      "output_file_id": "file-cvaTdG",
      "error_file_id": "file-HOWS94",
      "created_at": 1711471533,
      "in_progress_at": 1711471538,
      "expires_at": 1711557933,
      "finalizing_at": 1711493133,
      "completed_at": 1711493163,
      "failed_at": null,
      "expired_at": null,
      "cancelling_at": null,
      "cancelled_at": null,
      "request_counts": {
        "total": 100,
        "completed": 95,
        "failed": 5
      },
      "metadata": {
        "customer_id": "user_123456789",
        "batch_description": "Sentiment classification"
      }
    },
    ......
  ],
  "first_id": "batch_abc123",
  "last_id": "batch_abc456",
  "has_more": true
}

```