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 の失敗
概要

CLI Connection Settings

Signal Foundry CLI が production API と API key を使うための最小設定です。

このページの内容5項目
最初に設定する一時的に上書きするagent ごとに設定を分けるHTTP API を直接呼ぶ場合このページで扱わないこと

Signal Foundry を公開環境で使うときに設定するものは、基本的に base URL と API key だけです。

  • production base URL: https://signal-foundry.app
  • API key: API キー設定画面で発行したキー

Quick Start では、この 2 つを sf auth setup で保存します。環境変数や config path は、CI や agent ごとに設定を分けるときだけ使います。

最初に設定する

sf auth setup --base-url https://signal-foundry.app
sf auth show --json

auth setup は API key をターミナルの隠し入力で受け取ります。API key を docs、prompt、shell history、agent の会話ログには書かないでください。

すでに API キー設定画面を開いている場合は、ブラウザを開かずに進めます。

sf auth setup --base-url https://signal-foundry.app --no-open
sf auth show --json

auth show --json で見る key は次の 3 つです。

  • effectiveBaseUrl
  • effectiveApiKeyPreview
  • configPath

effectiveBaseUrl が https://signal-foundry.app で、API key preview が表示されていれば、公開 API への接続設定は完了です。

一時的に上書きする

CI や agent job で保存済み config を使わない場合は、環境変数で一時的に上書きできます。

export SIGNAL_FOUNDRY_BASE_URL="https://signal-foundry.app"
export SIGNAL_FOUNDRY_API_KEY="<SIGNAL_FOUNDRY_API_KEY>"
sf auth show --json

通常の手元環境では sf auth setup を使う方が安全です。環境変数は shell history、CI secret、agent log の扱いを確認してから使ってください。

agent ごとに設定を分ける

Codex、Claude Code、CI job で別の API key を使う場合は、config path を分けます。

export SIGNAL_FOUNDRY_CONFIG_PATH="$PWD/.signal-foundry/config.json"
sf auth setup --base-url https://signal-foundry.app
sf auth show --json

この設定は現在の shell だけに効きます。別の terminal session では、もう一度 SIGNAL_FOUNDRY_CONFIG_PATH を設定してください。

HTTP API を直接呼ぶ場合

HTTP API を直接呼ぶ場合は、保存済み config ではなく認証ヘッダーを送ります。

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

API key の作成とローテーションは API Key Settings を見てください。CLI の認証コマンド一覧は CLI Authentication にあります。

このページで扱わないこと

ソースコードを直接触るための開発環境設定は、公開利用者の初期設定ではありません。

CLI と agent から公開 API を使う場合は、production base URL と API key だけを設定してください。

Preview URL を API base URL にしないでください。公開 docs の手順では https://signal-foundry.app を使います。

このページの内容

最初に設定する一時的に上書きするagent ごとに設定を分けるHTTP API を直接呼ぶ場合このページで扱わないこと