ファイルとバッチ
List Batches
現在の Workspace 内のバッチを一覧取得します。
概要
現在の Workspace で POST /v1/batches を通じて作成されたバッチを新しい順に返します。Message Batches は メッセージバッチの一覧取得 で一覧取得できます。
クエリパラメータ
limitintegerqueryデフォルト:
20返されるバッチの数(1 から 100 まで)。
afterstringquery
バッチ ID カーソル: この ID より後のバッチを返します。前のページの
last_id を使用します。before と組み合わせることはできません。beforestringquery
バッチ ID カーソル: この ID より前のバッチを返します。
after と組み合わせることはできません。orderstringqueryデフォルト:
desc作成時間順に
asc または desc。リクエスト
curl -X GET "https://api.tokenlab.sh/v1/batches?limit=20" \
-H "Authorization: Bearer sk-your-api-key"レスポンス
{
"object": "list",
"data": [{ "id": "batch_abc123", "object": "batch", "status": "completed" }],
"first_id": "batch_abc123",
"last_id": "batch_abc123",
"has_more": false
}重要なフィールド
objectstring
常に
list。dataarray
バッチのリスト。
statusstring
各バッチのステータス。
has_moreboolean
has_more が true の場合、さらに取得可能な結果が存在します。認証
BearerAuth AuthorizationBearer <token>
APIキー認証。Dashboard > API > API KeysでAPIキーを作成または管理します。
場所: header
クエリパラメータ
limit?integer
返すバッチ数。デフォルトは20。
範囲
1 <= value <= 100デフォルト
20after?string
バッチIDカーソル:このバッチ以降のバッチを返します。beforeと組み合わせることはできません。
before?string
バッチIDカーソル:このバッチ以前のバッチを返します。afterと組み合わせることはできません。
order?string
作成日時によるソート順。
デフォルト
"desc"指定できる値
- "asc"
- "desc"
レスポンス
application/json
application/json
application/json