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

概要

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

はじめに
sf CLI をインストールクイックスタートデータの出所カバレッジとタグ
CLI 概要
基本コマンドCLI 認証会社検索求人検索建設業許可検索ヘルプとエラーコマンドとフラグCLI 更新
認証
APIキーのライフサイクル利用状況の見方
請求
クレジット表
トラブルシュート
認証・接続・制限エラー低ヒット検索の見直し方クレジットと maxCredits の失敗
認証

認証の全体像

Signal Foundry の認証を、ワークスペースログイン、チームワークスペース、CLIログイン、API キーの順に整理します。

このページの内容5項目
install 後にやること役割分担覚えておく前提最初に読む順番Claude Code / Codex で使うときの原則

Signal Foundry の認証は 3 段階です。

  • ワークスペースログイン: ブラウザでワークスペースに入るためのログイン
  • チームワークスペース: Company Search、credit、billing、API キーの利用範囲
  • API 利用認証: CLI / API / エージェントの接続方法

ブラウザへログインするだけでは CLI は使えません。公開利用では、チームワークスペースを作り、CLI 側で sf login を完了します。API キーは backend や secret store から直接 API を呼ぶ用途に限定します。

install 後にやること

  1. https://signal-foundry.app にサインアップまたはサインインします。
  2. 最初のチームワークスペースを作成します。
  3. sf login --json を実行します。
  4. sf auth show --json で有効設定を確認します。
  5. sf search 7203 --json で最初の疎通確認をします。

この 5 手で認証は完了です。

役割分担

  • UI に入る: ワークスペースログイン
  • 通常の利用単位を作る: チームワークスペース
  • CLI / エージェントで API を叩く: sf login
  • 直接 API の認証情報を作る: チームワークスペースの API キー設定画面
  • 利用量を確認する: 利用状況の見方

覚えておく前提

  • 公開利用の人間 / エージェント接続は sf login 前提です
  • API キーは account 単位の service 認証情報です
  • 通常の利用範囲はチームワークスペースです
  • account_id は通常不要です
  • Preview URL は正規の接続先にしません

最初に読む順番

  1. クイックスタート
  2. CLI認証
  3. APIキーのライフサイクル
  4. 利用状況の見方

Claude Code / Codex で使うときの原則

  • API キーは chat に貼らず、通常は sf login を使う
  • エージェントには sf auth show --json から始めさせる
  • 失敗時は error.hint と error.suggested_next_commands を優先する

初回導入では、まず sf login で sf search と sf company <companyId> --json まで成功させることだけを考えてください。

このページの内容

install 後にやること役割分担覚えておく前提最初に読む順番Claude Code / Codex で使うときの原則