使用量の照会

GET /api/v1/obs/usage

組織の使用量と消費金額を、日別 / モデル別 / チーム別 / キー別に集計して照会します。

認証:本エンドポイントはコンソールバックエンド API(Base URL https://portal.aiin1.aiapi.portal.aiin1.ai ではありません)に属します。コンソールアカウントでログインして取得した access_token(15 分間有効)が必要で、sk-nex- API トークンは使用できません。ログイン方法と自動照合の完全な手順は 請求照合と使用量自動同期 を参照してください。

リクエストパラメータ

パラメータ 位置 必須 説明
start / end query date いいえ 期間(YYYY-MM-DD、両端含む)。必ずペアで指定、範囲 ≤ 365 日、end に未来日は不可。省略時は range_days を使用
range_days query integer いいえ 直近 N 日(デフォルト 7)
group query string いいえ 集計軸:date(デフォルト)/ model / team / key / owner。カンマ区切りで多次元クロス集計が可能(例:group=model,key)。組み合わせ時は group_key / group_name が指定順に | で連結されます
team_id query string(uuid) いいえ チームで絞り込み
apikey_id query string(uuid) いいえ API キーで絞り込み
model query string いいえ モデル名で絞り込み

リクエスト例

curl "https://portal.aiin1.ai/api/v1/obs/usage?start=2026-07-01&end=2026-07-31&group=model" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

レスポンス

配列を返します。各行は 1 つの集計グループです:

フィールド 説明
group_key string 集計キー(日付 / モデル名 / チームまたはキーの ID)
group_name string | null 集計キーの表示名
request_count integer リクエスト数
prompt_tokens integer 入力トークン
completion_tokens integer 出力トークン
cache_creation_input_tokens integer キャッシュ書き込みトークン
cache_read_input_tokens integer キャッシュヒットトークン
total_tokens integer 合計トークン
cost_usd string(decimal) 消費金額(USD)
avg_latency_ms integer | null 平均レイテンシ(ミリ秒)
error_count integer エラー数

関連:リクエスト単位の明細エクスポート

同じプレフィックスでリクエスト単位の明細エクスポートも提供しています(start / end 必須、任意で model / apikey_id / team_id):

  • GET /api/v1/obs/usage/export — CSV(各行に適用単価と割引係数を含み、cost_usd を独立に再計算可能)
  • GET /api/v1/obs/usage/export.xlsx — Excel 明細
  • GET /api/v1/obs/usage/stats.xlsx — Excel 統計

列の説明は 請求照合と使用量自動同期 を参照してください。