ダッシュボードAPI
Markdownダッシュボードのメソッド:ログイン、プロフィール、キー、支出履歴。
完全ガイド
アドレスと認証
- ダッシュボード:https://ailoot.ai(ログインとダッシュボードのトークン)
- モデルAPI:https://api.ailoot.ai(キーsk-…)
| 項目 | アドレス | 認証 |
|---|---|---|
| ダッシュボードAPI | https://ailoot.ai/api/v1 | Authorization: Bearer $TOKEN は、ログイン後に取得するダッシュボードのトークンです。 |
| モデルAPI | https://api.ailoot.ai/v1 | キー sk-… は「APIキー」セクションで取得します。参照:APIキーとAPIアドレス |
キー sk-… はダッシュボードのトークンの代わりにはなりません。ダッシュボードのトークンでもモデルAPIは利用できません。完全なパスは、各メソッドに記載されています。
curl --fail-with-body "https://ailoot.ai/api/v1/user/profile" \
-H "Authorization: Bearer $TOKEN"レスポンス形式とエラー
レスポンスにはcode、message、dataが含まれます。エラーにはreasonとmetadataが含まれることがあります。dataのページネーションにはitems、total、page、page_size、pagesが含まれます。各メソッド固有の形式は、その説明に記載されています。
{
"code": 0,
"message": "success",
"data": {
"items": [],
"total": 0,
"page": 1,
"page_size": 20,
"pages": 1
}
}ダッシュボードのトークンは、有効期限とユーザーが有効かどうかで検証されます。セッションの紐付けが有効な場合は、IPとブラウザーも確認されます。TOKEN_EXPIRED、TOKEN_REVOKED、USER_INACTIVE、INVALID_TOKEN、FORBIDDENは、セッションと権限の問題を区別するコードです。頻度制限や追加の2FA確認によって、個々のリクエストが拒否される場合があります。
リファレンスの読み方
- 各項目には、HTTPメソッド、完全なパス、アクセス条件、パラメータ、ボディのフィールド、レスポンスが記載されています。
- 識別子は以前取得したレスポンスから使ってください。KEY_IDはGET /api/v1/keysから、リクエストのIDはGET /api/v1/usageから取得します。
- オブジェクトのフィールドと型は、「データスキーマ」の各ページに記載されています。
- テンプレートは、フィールド名と型を示します。PLACEHOLDERとTOKENはマーカーであり、実データではありません。
- 残高は、ダッシュボードの「料金」セクションでチャージします。詳細:チャージ方法。
残高とfrozen_balance
プロフィールにはbalanceとfrozen_balanceが含まれます。frozen_balanceは、未完了のリクエスト用に仮確保している金額です。履歴と合わせて、両方のフィールドを確認してください。
キーと制限値
GET /api/v1/keysは、自分のキーを返します。フィールド quotaとquota_used は、キーの支出上限と、使用済みの金額です; ip_whitelist, ip_blacklist, statusとexpires_at は、キーの利用条件を制御します; rate_limit_5h, rate_limit_1dとrate_limit_7d は、支出ウィンドウごとの上限です。
curl --fail-with-body "https://ailoot.ai/api/v1/keys" \
-H "Authorization: Bearer $TOKEN"
# KEY_IDは一覧レスポンスに含まれる自分のキーのid
curl --fail-with-body "https://ailoot.ai/api/v1/keys/$KEY_ID" \
-H "Authorization: Bearer $TOKEN"支出とセキュリティ
履歴とdashboardのactual_costは、実際に残高から差し引かれた金額です。total_costは標準料金に基づく金額です。日付、モデル、キー、リクエスト種別のフィルターは、各メソッドに記載されています。パスワード、TOTP、passkeyの変更には、それぞれのメソッドで説明する確認が必要です。
このセクションには 39 のメソッドがあります。