列出 Batch - ChatfireAPI

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Query 参数

after

string

可选

此参数用作分页游标，指定从特定对象ID之后开始检索列表。例如，如果您的上一请求返回了包含对象 obj_foo 的列表，并希望继续从这一点获取后续内容，可以将 after=obj_foo 包括在您的下一请求中以获取下一页数据。

limit

string

可选

限制返回对象的数量。limit 的范围可以是 1 到 100，默认值为 20。

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

返回响应

🟢200成功

application/json

Body

object

string

必需

data

array [object {20}]

必需

id

string

事件id

可选

object

string

可选

endpoint

string

可选

errors

null

可选

input_file_id

string

可选

completion_window

string

可选

status

string

可选

output_file_id

string

可选

error_file_id

string

可选

created_at

integer

创建时间timestamp

可选

in_progress_at

integer

可选

expires_at

integer

可选

finalizing_at

integer

可选

completed_at

integer

可选

failed_at

null

可选

expired_at

null

可选

cancelling_at

null

可选

cancelled_at

null

可选

request_counts

object

可选

metadata

object

可选

first_id

string

必需

last_id

string

必需

has_more

boolean

是否还有更多

必需

示例

{
  "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": "Nightly job",
      }
    },
    { ... },
  ],
  "first_id": "batch_abc123",
  "last_id": "batch_abc456",
  "has_more": true
}