アカウント
APIキーが属するアカウント用の2つの読み取り専用エンドポイント：プランと利用可能クレジットのスナップショット（SDKがセルフスロットリングに必要な2つの数値を含む）、およびセルフサービスでの調整のためのクレジット消費のページネーション付き台帳です。
アカウントの取得
アカウントの有効プランとクレジットを返します。アカウントがチームのメンバーである場合、これは個人のメンバーシッププランではなく、チームオーナーのプラン/クレジットプールを反映します。
パラメータ
なし — アカウントはAuthorizationヘッダーのAPIキーによって完全に決定されます。
max_batch_sizeとupload_concurrencyは、クライアントSDKがinvalid_parameter/rate_limit_exceededエラーに最初に当たってからこれらの制限を発見するのではなく、自身のアップロードループをセルフスロットリングできるように提供されています。
発生しうるエラー
missing_api_key/invalid_api_key/plan_required— 詳細はエラーハンドリングをご覧ください。
アカウント使用量の取得
アカウント上のクレジットに影響するすべてのイベント（抽出による消費、バウンディングボックス注釈による消費、返金）を、新しい順にページネーションで表示する台帳です。「この処理にクレジットがいくらかかったか」を確認するためのもので、UI駆動を目的としていません（/profile/usage_historyの整形済み表示文字列と比較してください。このエンドポイントはそのような文字列を返さず、代わりに構造化された符号付きamount値を返します）。
パラメータ
| 名前 | 場所 | 型 | 説明 |
|---|---|---|---|
limit | クエリ、オプション | 整数 | 1～200。デフォルトは50。 |
batch_name | クエリ、オプション | 文字列 | 台帳を特定のバッチのエントリに制限します。「バッチXのクレジット消費量はいくらか」を確認する場合に使用します。 |
page_token | クエリ、オプション | 文字列 | 前回のレスポンスのnext_page_tokenから受け取る不透明なカーソルです。このエンドポイントは新しい順にページネーションします（他のv1リストエンドポイントは古い順です）。トークンは不透明で、同じ方法でラウンドトリップしますが、内部の順序のみが異なります。詳細はページネーションをご覧ください。 |
amountは符号付きです。負の値は消費（抽出/バウンディングボックス注釈による消費）、正の値はクレジットの戻り（返金/キャンセル返金）を表します。そのため、1ページのamount値を合計すると、そのページの正味の変化量が得られます。document_idはドキュメントのdocument_idと同じID空間です（内部台帳ではtask_idと呼ばれますが、このエンドポイントではv1の他の部分との一貫性のために名前を変更しています）。
発生しうるエラー
missing_api_key/invalid_api_key/plan_required— 詳細はエラーハンドリングをご覧ください。invalid_parameter—limitまたはpage_tokenが不正です。