Lingara Lingara ドキュメント 学習ガイド API ライブラリ アプリ 作成 ウェブ版
言語: 日本語

残りの利用枠を取得

API バージョン 2026-10-affable-towhee

get https://api.getlingara.com/v1/usage

アカウントに適用される各利用枠を、使用量とリセット日時とともに一覧表示します。

スコープ usage:read

パラメーター

Lingara-Versionheaderstring任意
このリクエストに応答する API バージョン。指定がない場合、アクセストークンはそのクライアントに固定されたバージョンを、トークンのないリクエストは現行バージョンを受け取ります。開発中のバージョンには、ここで指定した場合にのみアクセスできます。不明なバージョンにはコード api_version_unknown とともに 400 を返します。GET /v1/versions でバージョンを一覧できます。

レスポンス

200 利用枠

allowancearray of AllowanceRow必須
featurestring必須
windowstring必須
limitinteger必須
usedinteger必須
remaininginteger必須
reset_atinteger | null任意
ledgerUsageLedger | null任意

月初日の UTC 午前 0 時以降の、このクライアントの呼び出し数とユニット数です。従量課金クライアントの場合にのみ含まれ、その呼び出しは利用枠を消費しません。最新の呼び出しから最大 5 秒遅れることがあります。

sincestring必須
callsinteger必須
unitsinteger必須

エラー

410application/json
このリクエストに応答する API バージョンは提供を終了しました。Lingara-Version でサポート対象のバージョンを送るか、クライアントを別のバージョンに固定し直してください。
4XXapplication/json
リクエストは拒否されました。code が理由を示し、error がそれを文章で説明します。
503application/json · text/plain
サービスは一時的に利用できません。Retry-After に示された秒数が経過してから再試行してください。メンテナンス中は、本文はエラーエンベロープではなくプレーンテキストになります。
5XXapplication/json
リクエストは拒否されました。code が理由を示し、error がそれを文章で説明します。
codestring必須

リクエストが拒否された理由を、分岐に使える安定したコードで示します。例:insufficient_scope(403)、rate_limited(429)、従量課金クライアントの場合は spend_cap_reached(402)と metered_billing_inactive(402)。

errorstring必須

例

コード例の言語

curl

curl "https://api.getlingara.com/v1/usage" \
  -H "Authorization: Bearer $LINGARA_TOKEN"

TypeScript

const usage = await client.getUsage();
for (const row of usage.allowance) {
  console.log(row.feature, row.window, `${row.remaining} of ${row.limit} left`);
}

Rust

let usage = client.get_usage().await?;
for row in &usage.allowance {
    println!("{} {}: {} of {} left", row.feature, row.window, row.remaining, row.limit);
}

Go

usage, err := client.GetUsage(ctx)
if err != nil {
	return err
}
for _, row := range usage.Value.Allowance {
	fmt.Printf("%s (%s): %d of %d left\n", row.Feature, row.Window, row.Remaining, row.Limit)
}

Java

import com.getlingara.client.model.AllowanceRow;
import com.getlingara.client.model.Usage;

Usage usage = client.getUsage().body();
for (AllowanceRow row : usage.getAllowance()) {
  System.out.println(
      row.getFeature()
          + " ("
          + row.getWindow()
          + "): "
          + row.getRemaining()
          + " of "
          + row.getLimit()
          + " left");
}

Kotlin

val usage = client.getUsage().body
for (row in usage.allowance) {
    println("${row.feature} (${row.window}): ${row.remaining} of ${row.limit} left")
}

Ruby

usage = client.get_usage.value
usage.allowance.each { |row| puts "#{row.feature} (#{row.window}): #{row.remaining} of #{row.limit} left" }
puts "#{usage.ledger.calls} calls this month" if usage.ledger

PHP

foreach ($client->getUsage()->value->getAllowance() as $row) {
    echo $row->getFeature(), ': ', $row->getRemaining(), ' of ', $row->getLimit(), ' left this ', $row->getWindow(), "\n";
}

ライブラリを使いたい場合は、ライブラリのセクションをご覧ください。

翻訳と英語版リファレンスの内容が異なる場合は、英語版リファレンスが正しいものとします。