ファイルとバッチ

メッセージバッチの一覧取得

組織が作成したメッセージバッチの一覧を取得します。

GET
/v1/messages/batches

概要

このAPIを通じて組織が作成したメッセージバッチを、新しい順に返します。このリストには、各バッチに対してTokenLabが最後に記録したステータスが表示されます。特定のバッチを今すぐ確認するには、バッチの取得を使用してください。

注意事項

  • limit は1から1000の間で指定でき、デフォルト値は20です。
  • ページネーションを行うには、リスト内のバッチIDを使用して after_id(より古いバッチ)または before_id(より新しいバッチ)を渡します。両方を同時に送信しないでください。不明なIDやその他のクエリパラメータが指定された場合、TokenLabは 400 を返します。
  • 削除されたバッチはリストに含まれません。
  • 後続のバッチが存在する場合、has_more は true になります。

例

リクエスト

cURL
curl -X GET "https://api.tokenlab.sh/v1/messages/batches?limit=20" \
  -H "x-api-key: sk-your-api-key" \
  -H "anthropic-version: 2023-06-01"

レスポンス例

レスポンス

200 OK
{
  "data": [
    {
      "id": "msgbatch_01ABC123",
      "type": "message_batch",
      "processing_status": "ended",
      "request_counts": { "processing": 0, "succeeded": 2, "errored": 0, "canceled": 0, "expired": 0 },
      "ended_at": "2026-11-01T10:20:00Z",
      "created_at": "2026-11-01T10:00:00Z",
      "expires_at": "2026-11-02T10:00:00Z",
      "cancel_initiated_at": null,
      "archived_at": null,
      "results_url": "https://api.tokenlab.sh/v1/messages/batches/msgbatch_01ABC123/results"
    }
  ],
  "first_id": "msgbatch_01ABC123",
  "last_id": "msgbatch_01ABC123",
  "has_more": false
}

重要なフィールド

dataarray
メッセージバッチのリスト(新しい順)。
first_idstring|null
data 内の最初のバッチのID。
last_idstring|null
data 内の最後のバッチのID。
has_moreboolean
has_more が true の場合、さらにバッチが存在します。

認証

BearerAuth
AuthorizationBearer <token>

APIキー認証。Dashboard > API > API KeysでAPIキーを作成または管理します。

場所: header

クエリパラメータ

before_id?string

このバッチIDより前のバッチを返します。after_id と組み合わせることはできません。

after_id?string

このバッチIDより後のバッチを返します。before_id と組み合わせることはできません。

limit?integer

返すバッチの最大数

範囲1 <= value <= 1000
デフォルト20

レスポンス

application/json

application/json

application/json

application/json

application/json

application/json

application/json