使用量の取得

GET /v1/usage

認証済みユーザーの請求期間における現在の抽出使用量を取得します。このエンドポイントを使用して消費量を監視し、プラン制限の超過を回避します。

試してみる

このエンドポイントを Swagger UI でインタラクティブにテストできます。

認証が必要です

Authorization ヘッダーにAPIキーを含めてください。

リクエスト

ヘッダー

ヘッダー	値	必須
Authorization	Bearer <token>	はい

このエンドポイントにはクエリパラメータやリクエストボディはありません。

コード例

curl

curl https://api.docmap.io/v1/usage \
  -H "Authorization: Bearer dm_live_abc123def456ghi789jkl012mno345"

TypeScript

const apiKey = process.env.DOCMAP_API_KEY

const response = await fetch('https://api.docmap.io/v1/usage', {
  headers: { 'Authorization': `Bearer ${apiKey}` },
})

const { data } = await response.json()
console.log(`${data.usage} / ${data.limit} extractions used (${data.plan} plan)`)

Python

import requests

api_key = "dm_live_abc123def456ghi789jkl012mno345"

response = requests.get(
    "https://api.docmap.io/v1/usage",
    headers={"Authorization": f"Bearer {api_key}"},
)

data = response.json()["data"]
print(f"{data['usage']} / {data['limit']} extractions used ({data['plan']} plan)")

レスポンス

ステータス: 200 OK

レスポンスボディは data オブジェクトでラップされています。

フィールド

フィールド	型	説明
plan	string	ユーザーの現在のプラン: free、starter、core、または pro。
usage	number	現在の請求期間で消費された抽出回数。
limit	number	現在のプランで許可される最大抽出回数。
periodKey	string	現在の請求期間（YYYY-MM 形式）。

例

{
  "data": {
    "plan": "starter",
    "usage": 142,
    "limit": 500,
    "periodKey": "2024-11"
  }
}

エラー

ステータス	コード	説明
401	UNAUTHORIZED	APIキー/トークンが欠落、無効、または期限切れです。