Signal Foundry
ドキュメント
サポート 戻る
ドキュメントユースケースAPI リファレンスリリースノート

概要

Agent が迷わず使える順に整理しています。

はじめに
sf CLI をインストールクイックスタート会社IDの見方データの出所カバレッジとタグ
認証
認証設定APIキーのライフサイクル利用状況の見方APIキー認証アカウントスコープは通常不要レート制限とエラー
請求
利用プラン利用量の計測クレジット表
CLI
CLI 概要CLI 認証基本コマンド会社検索求人検索会社・事例・観測・開示建設業許可検索ヘルプとエラーコマンドとフラグCLI 更新
トラブルシュート
会社が見つからないとき認証・接続・制限エラー低ヒット検索の見直し方プレビューURLの注意クレジットと maxCredits の失敗
請求

利用量の計測

API usage summary と プロダクト内のクレジット台帳の違いを説明します。

このページの内容4項目
API usage summaryPlan quotaProduct クレジット台帳何に使うか

Signal Foundry には 2 種類の metering があります。

Metering何を見るか主な用途
API usage summaryrequest count、endpoint、response bytesAPI key の利用状況・rate limit 調整
Plan quotasearch / card / deep signal の残りと quota error の reset_atdaily_* / monthly_* quota error の復旧
Product クレジット台帳Request / Signal / 付与 / reservationユーザーが使えるクレジット残高と消費

API usage summary

主に見ている項目は次のとおりです。

  • request count
  • endpoint breakdown
  • response bytes
  • last request at

これらは API キー設定画面の usage summary で確認できます。

この summary は「どの API key がどれだけ使われたか」を見るための 30 日 breakdown です。plan quota の残り、credit 残高、請求額そのものではありません。

Plan quota

Plan quota は次で確認します。

sf usage --json

Free は search 1,000/day、Company Card 2,000/day、deep signal 200/day、120 RPM です。Pro は search 5,000/month、Company Card 10,000/month、deep signal 1,000/month、300 RPM です。

daily_*_quota_exceeded / monthly_*_quota_exceeded が出た場合は、sf usage --json で残りを確認し、quota error の error.reset_at まで待つか条件を絞ります。Credit Pack は credit 残高を増やしますが、plan quota や RPM は増やしません。

Product クレジット台帳

クレジットの残高と 付与内訳は次で確認します。

sf credits balance --json
sf credits summary --json

credits balance は残高、credits summary は直近期間の usage event summary です。請求計算そのものではなく、プロダクト上の利用可能量と消費履歴を確認するために使います。

何に使うか

  • 利用頻度の把握
  • heavy endpoint の特定
  • pilot 顧客の利用実態確認
  • rate limit の見直し
  • Request / Signal credit の使われ方の確認

Stripe subscription / order は 付与を作る入口です。実際のプロダクト利用可否は sf_credit_grants と 消費記録で判断します。

操作ごとのクレジット消費は クレジット表 を見ます。取得元と根拠の出所は データの出所 を見ます。

このページの内容

API usage summaryPlan quotaProduct クレジット台帳何に使うか