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

概要

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

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

クレジット表

Signal Foundry の操作ごとのクレジット消費、無料境界、再試行ルールを固定します。

このページの内容8項目
まず見る commandPlan 付与Plan quota / rate boundaryOperation schedule実行前の確認Idempotency復旧方法次に読むページ

このページは、Signal Foundry のクレジット入出力です。

クレジットは data request と credit-consuming Signal read の両方を ledger で扱います。Signal Foundry の Company-first data endpoint を API / CLI から読むと Request Credit、一部の signal read では追加の Signal Credit を使います。

まず見る command

sf credits balance --json
sf credits summary --json
sf usage --json
sf query --file company-query.json --json

見る key:

  • balance.available_credits
  • balance.remaining_credits
  • balance.reserved_credits
  • balance.grants[]
  • summary.used_credits
  • summary.meterBreakdown[]
  • summary.usageBreakdown[]
  • usage_limits.remaining
  • usage_limits.limits.plan
  • query.executors.financial_gold.status
  • query.executors.financial_gold.result.matched_count
  • companies[].company.company_id
  • warnings[]
  • meta.coverage_warnings
  • meta.returned_companies

credits balance は「今実行できるか」を見ます。credits summary は「何が credit event を作ったか」を見ます。 財務しきい値は自然文 q に残さず、company_query.v1 を作って sf query --file company-query.json --json で実行します。

Plan 付与

契約とクレジット付与の単位はチームワークスペースです。1 人で使う場合も、owner だけのチームワークスペースが API key、usage、billing の範囲になります。

Plan / 付与ScopeQuota / CreditNotes
Free quotaチームワークスペース0 円、10,000 request credits/month から始まる探索枠agent exploration
Pro quotaチームワークスペース9,800 円/month 税込、higher monthly volume、rate headroom本番・商用利用
Pro monthly credit grantチームワークスペース20,000 / monthcredit ledger 付与
Credit Pack 10000チームワークスペース5,000 円 税込、10,000 / purchase3 ヶ月有効

個人向け checkout は通常導線にしません。個人 account は認証 identity と初期設定のために存在し、通常の実行範囲はチームワークスペースです。

Credit Pack は credit 残高を増やす one-time purchase です。plan quota、RPM、batch 上限、検索結果上限は増やしません。

Plan quota / rate boundary

BoundaryFreePro
Searches1,000/day5,000/month
Company Cards2,000/day10,000/month
Credit-consuming Signal reads200/day1,000/month
API rate limit120 RPM300 RPM
Search results50/request100/request
Signal results50/request100/request
Search offset500 max10,000 max
Page depth10 maxno fixed cap
Batch resolve / batch signalsunavailable in Free500 resolve / 100 signals

Batch / bulk endpoints は direct integration 用の上限を持ちますが、初回成功や通常の v0 公開 workflow の前提にはしません。複数会社を扱う通常導線では、Search JSON を agent 側でローカルに整形し、必要な会社だけ Company Card / Signals を読みます。

Operation schedule

OperationRequest CreditSignal CreditCLI
company search10sf company search 7203 --json
company profile10sf company profile jpx_7203 --json
company cases11 when used as a credit-consuming signal readsf company cases jpx_6836 --json
company observations10sf company observations jpx_7203 --json
company filings11 when used as IR evidencesf company filings jpx_7203 --json
query1 when executable search runs0sf query --file company-query.json --json
根拠の確認10Company Card と company-level signals を読む
job search10sf job search "<query>" --json
construction search10sf construction search "<query>" --json
credit-consuming Signal read1signal 単位sf usage --json と sf credits summary --json で利用量を確認
credits balance / credits summary / feedback create00sf credits balance --json

credits、usage、feedback などの確認・管理 endpoint は request credit の対象外です。

実行前の確認

credit-consuming Signal read や高い volume の利用前に、残高と直近利用を確認します。

sf credits balance --json
sf credits summary --json
sf credits summary --days 7 --limit 5 --json
sf usage --json

v0 の通常探索では、agent が sf company search の JSON からローカルリストやCSVを作ります。サーバー側 workspace 実行は compatibility surface です。

Idempotency

同じ書き込みを再試行する場合は idempotency を使います。

SurfaceRequiredNotes
CLIcommand 側で safe retry を扱う。必要なら --idempotency-key を指定失敗時は error.suggested_next_commands を見る
HTTP APIIdempotency-Key header書き込み系 API で使う

同じ会社 / signal / idempotency key の再試行では二重消費しません。対象、上限、idempotency key を変える場合は別実行として扱います。

復旧方法

Error次に見る command復旧
max_credits_requiredsf <command> --help--max-credits <n> を付ける
max_credits_exceededsf company search "<query>" --json検索条件や対象会社数を絞る
credit_balance_insufficientsf credits balance --json付与残高を確認する
daily_search_quota_exceeded / monthly_search_quota_exceededsf usage --jsonreset_at を待つ、条件を絞る、Free なら Pro の月次 quota を使う
daily_card_quota_exceeded / monthly_card_quota_exceededsf usage --jsonreset_at を待つ、読む会社を絞る、Free なら Pro の月次 quota を使う
daily_deep_signal_quota_exceeded / monthly_deep_signal_quota_exceededsf usage --jsonsignal read の対象を絞るか reset_at を待つ
bulk_not_available_on_freesf usage --json通常導線では Search JSON と必要な Company Card / Signals に分ける。direct integration で batch が必要なら Pro の batch 上限を確認する
account_scope_conflictsf auth show --jsonAPI key のチームワークスペース範囲に任せ、request 側の account 指定を外す

unsupported / weak / needs_human が返る場合は、クレジットを使う実行へ進みません。条件を分解して人間に確認してください。

次に読むページ

  • team plan: Access Plans
  • クレジット台帳: GET /credits/balance
  • usage summary: Usage Metering

このページの内容

まず見る commandPlan 付与Plan quota / rate boundaryOperation schedule実行前の確認Idempotency復旧方法次に読むページ