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

概要

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

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

CLI 認証

sf CLI のログイン、接続確認、再ログイン手順を扱います。

このページの内容4項目
初期設定接続状態を見るよく使う auth コマンドうまくいかないとき

このページは、sf CLI の認証状態を確認したり、エージェントごとの設定を分けたりするときのリファレンスです。初回接続だけなら クイックスタート で十分です。

公開利用では、接続先は https://signal-foundry.app に揃えます。通常の人間 / エージェント接続は sf login です。API key は CLI onboarding では使わず、API を直接呼び出す組み込み、backend job、.env / secret store で管理するプロダクト組み込みに使います。

初期設定

sf login --json
sf auth show --json

API key はドキュメント、prompt、shell history、エージェントの会話ログには書かないでください。

接続状態を見る

auth show --json の代表的な出力は次です。

{
  "authMode": "oauth",
  "storedApiKeyPreview": null,
  "storedBaseUrl": "https://signal-foundry.app",
  "effectiveCredentialType": "oauth_access_token",
  "effectiveCredentialPreview": "eyJhbG...redacted",
  "effectiveApiKeyPreview": null,
  "effectiveBaseUrl": "https://signal-foundry.app",
  "oauth": {
    "tokenAvailable": true
  }
}

まず見る key:

  • effectiveBaseUrl
  • authMode
  • effectiveCredentialType
  • oauth.tokenAvailable

effectiveBaseUrl が https://signal-foundry.app で、authMode: "oauth"、oauth.tokenAvailable: true なら、CLI は production API に接続できます。

よく使う auth コマンド

sf auth --help --json
sf login --json
sf auth show --json
sf auth logout

通常は login と show だけで足ります。API key を使う直接の API 連携は、CLI 設定ではなくプロダクト側の .env や secret store で管理してください。

うまくいかないとき

状態確認すること
401 authentication_requiredsf auth show --json で authMode と oauth.tokenAvailable を確認
effectiveBaseUrl が違う、または別 account の結果が返るsf login --json をやり直す

401 / 404 / 429 の詳しい切り分けは 認証・401・404・429 を見てください。

Preview URL は、公開利用の接続先にしません。公開ドキュメントの手順では https://signal-foundry.app を使います。

oauth_email_not_allowed が返る場合:

  1. 表示された email_hint / email_domain を確認します。
  2. 許可済みメールで sf login --json をやり直します。
  3. 解決しない場合は、表示された email_hint と実行したコマンドを別経路で共有してください。

このページの内容

初期設定接続状態を見るよく使う auth コマンドうまくいかないとき