リファレンス

アカウント

APIキーが属するアカウント用の2つの読み取り専用エンドポイント:プランと利用可能クレジットのスナップショット(SDKがセルフスロットリングに必要な2つの数値を含む)、およびセルフサービスでの調整のためのクレジット消費のページネーション付き台帳です。

アカウントの取得

アカウントの有効プランとクレジットを返します。アカウントがチームのメンバーである場合、これは個人のメンバーシッププランではなく、チームオーナーのプラン/クレジットプールを反映します。

GET /api/v1/account

パラメータ

なし — アカウントはAuthorizationヘッダーのAPIキーによって完全に決定されます。

max_batch_sizeとupload_concurrencyは、クライアントSDKがinvalid_parameter/rate_limit_exceededエラーに最初に当たってからこれらの制限を発見するのではなく、自身のアップロードループをセルフスロットリングできるように提供されています。

発生し得るエラー

アカウント利用状況の取得

アカウント上のクレジットに影響するすべてのイベント(抽出の消費、バウンディングボックス注釈の消費、返金)を、新しい順にページング形式で記録した台帳です。「この処理にクレジットがいくらかかったか」を照合するためのもので、UIを駆動するためのものではありません(/profile/usage_historyの整形済み表示文字列と比較してください。このエンドポイントはそれを返さず、代わりに構造化された符号付きのamount値を返します)。

GET /api/v1/account/usage

パラメータ

名前場所型説明
limitクエリ、任意整数1〜200。デフォルトは50。
batch_nameクエリ、任意文字列台帳を1つのバッチのエントリに限定します — 「バッチXのクレジット消費はいくらだったか」を確認できます。
page_tokenクエリ、任意文字列前回のレスポンスのnext_page_tokenから取得する不透明なカーソルです。このエンドポイントは新しい順にページングします(他のv1リストエンドポイントは古い順)。トークンは依然として不透明で、同じ方法で往復しますが、基盤となる順序だけが異なります。ページネーションを参照してください。

amountは符号付きです:消費(抽出/バウンディングボックス注釈)では負、クレジットの戻り(返金/キャンセル返金)では正になります。したがって、1ページ分のamount値を合計すると、そのページでの正味の変化が得られます。document_idはドキュメントのdocument_idと同じID空間です(内部台帳ではtask_idと呼びますが、このエンドポイントはv1の他の部分との一貫性のために名前を変更しています)。

消費の大きさは常に1とは限りません。すべてのアカウントにはモデルティア(Standard(デフォルト)、Advanced、Premium)があり、どのAIモデルが抽出を実行するか、処理された各ドキュメントのクレジットコスト(Standardは1、Advancedは3、Premiumは6)を決定します。これをAPI呼び出しごとに設定する方法はありません。ImageToTable.aiチームがアカウントに割り当てます。アカウントがStandardでない場合、actionフィールドにはベア名ではなくティアの接尾辞が付きます — deduction_advanced、deduction_premium — これにより、amountを直接調べなくても非Standardの課金を識別できます。返金は後からのティア変更の影響を受けません:タスクは常に、処理開始時に実際に課金されたティアで返金され、返金が発生した時点のアカウントのティアではありません。したがって、refund行の大きさは、それが相殺するdeduction/deduction_<tier>行と常に一致します。これがv1が読み取る他のすべてのアカウントレベル設定とどう相互作用するかについては、アカウント設定とAPIの動作を参照してください。

発生しうるエラー

  • missing_api_key / invalid_api_key / plan_required — エラーハンドリングを参照してください。
  • invalid_parameter — limitまたはpage_tokenが不正です。
📮 contact email: [email protected]