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

概要

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

はじめに
Claude Code / Codex で始めるドキュメントマップsf CLI をインストールデータ・API・CLIの現況クイックスタートCLI 接続設定会社IDの見方初日の進め方Data Provenance
認証請求認証設定利用プランCLI
CLI 概要CLI 認証基本コマンド会社検索観測データ検索会社・観測・開示開示の表示・比較リスト・調査・クレジットヘルプとエラーコマンドとフラグCLI 更新
APIキーのライフサイクル利用量の計測提供中の機能
会社検索とプロフィール観測データ検索チームワークスペース会社の観測データ開示と比較APIキー管理UIリストワークスペース外部調査とクレジットSkills / CLI / API
Credit Schedule利用状況の見方APIキー認証アカウントスコープは通常不要レート制限とエラートラブルシュート
会社が見つからないとき認証・接続・制限エラー低ヒット検索の見直し方プレビューURLの注意credit と maxCredits の失敗estimate と materialize の失敗
認証

Account Scope は通常不要

Signal Foundry API は通常 API キーだけで利用できます。account scope を送るのは例外的な場合だけです。

このページの内容4項目
まず覚えること例送る場合のルール失敗パターン

通常の利用では、x-api-key または Authorization: Bearer だけで十分です。

Signal Foundry の API キーは account 単位で発行されるため、サーバー側は API キーから account_id を自動で解決します。通常は、リクエスト側で account_id を追加で送る必要はありません。

まず覚えること

  • 通常は API キーだけで使う
  • account_id は省略してよい
  • account scope を送るのは、明示的に scope を残したいときだけ

例

通常の呼び出し:

curl -H 'x-api-key: <SIGNAL_FOUNDRY_API_KEY>' \
  'https://signal-foundry.app/api/signal-foundry/companies?q=7203&limit=3'

必要な場合だけ、次のどちらかで account scope を明示できます。

  • x-account-id ヘッダー
  • account_id クエリパラメータ

送る場合のルール

  • x-account-id と account_id を両方送る場合は一致している必要がある
  • 送った account scope は、その API キーに紐づく account_id と一致している必要がある

失敗パターン

  • x-account-id と account_id が不一致
  • API キーの account_id と、送った scope が不一致

どちらも 400 account_scope_conflict になります。

複数アカウントをまたぐ運用や、ログ上で scope を明示したいケースだけ付与してください。それ以外では、API キーだけにしておくのが最も分かりやすく安全です。

通常の導入や agent 接続では、このページの内容を使わなくても問題ありません。まずは API キーだけで接続し、scope 明示が本当に必要になったときだけ戻ってください。

このページの内容

まず覚えること例送る場合のルール失敗パターン