Skip to content

App Attribution

公開のアプリ別トークンランキングを支える任意の識別ヘッダー。OpenRouter と互換性があります。

なぜ出所を示すのか#

PleumRouter を通じて呼び出すアプリを作る場合、2 つの識別ヘッダーで呼び出しの出所を示せます。 これらは公開のアプリ別トークンリーダーボードを構成し、あなたのアプリを露出させます。 ヘッダー名は OpenRouter と同じなので、既存の OpenRouter 設定をそのまま流用できます。

ヘッダーの送信#

課金されるすべての呼び出し(例: POST /v1/chat/completions)で、 HTTP-Referer(アプリの URL)と X-Title(アプリ名)を送れます。どちらも任意です。

chat completion with attribution headers
curl https://apirouter.pleum.ai/v1/chat/completions \
  -H "Authorization: Bearer $PLEUM_API_KEY" \
  -H "Content-Type: application/json" \
  -H "HTTP-Referer: https://myapp.example.com" \
  -H "X-Title: My App" \
  -d '{
    "model": "gpt-4o-mini",
    "messages": [{"role": "user", "content": "Hello"}]
  }'
両ヘッダーとも自己申告で検証されません。それぞれ 200 文字に切り詰められます。 値は使用量ログに保存されます。

リーダーボード#

GET/v1/stats/apps

GET /v1/stats/apps は認証不要の公開エンドポイントです。 トークン使用量順に上位 20 アプリを返します。

パラメータ必須説明
periodstring任意daily | weekly | monthly。デフォルト値 weekly
200 OK
{
  "leaderboard": [
    {
      "rank": 1,
      "app": "My App",
      "site": "https://myapp.example.com",
      "tokens": 523000,
      "calls": 410,
      "trend_pct": 12.4
    }
  ]
}

アプリキーは X-Title があればその値、なければ referer のホスト (パスを除去)です。trend_pct は直前の期間との変化率で、 過去データがない場合は null です。

値は自己申告で検証されません。どちらのヘッダーもない呼び出しや、ステータスコードが 400 以上の 呼び出しは、リーダーボードの集計から除外されます。