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 の失敗
トラブルシュート

Preview URL を使ってはいけない理由

Preview URL を API base URL にすると何が起きるかと、正しい切り替え方を説明します。

このページの内容6項目
何が問題かPR smoke だけ Preview を使う場合正しく使う接続先いま Preview URL を使っているか確認する切り替え手順失敗の見え方

Signal Foundry を agent や CLI から使うとき、Preview URL を正規の base URL として扱わないでください。

何が問題か

  • canonical な接続先ではない
  • Preview 側の認証や保護に引っかかることがある
  • 意図した環境の API / data contract とずれることがある
  • 401 404 network_error に見える失敗を作りやすい

つまり、Preview URL は「ブラウザで確認する URL」であって、agent が継続利用する API base URL ではありません。

PR smoke だけ Preview を使う場合

PR の route smoke では、Vercel Deployment Protection を automation 用 bypass header で通します。通常の CLI 接続先は production のままにし、smoke script だけ Preview URL を使います。

SIGNAL_FOUNDRY_VERCEL_PROTECTION_BYPASS=<vercel-bypass-secret> \
  pnpm --filter scripts sf:cli-preview-smoke -- --pr <pr-number>

この script は .vercel/.env.preview.local または .vercel/.env.preview.pulled の Preview Supabase 設定を使い、identity smoke に必要な fixture を upsert した上で一時 API key を作成し、smoke 後に削除します。production の API key を Preview に流用しません。

secret を shell history に残したくない場合は、ローカルの ~/.config/signal-foundry/vercel-preview.env に SIGNAL_FOUNDRY_VERCEL_PROTECTION_BYPASS=... を置き、chmod 600 にしてください。この file は repository に commit しません。

正しく使う接続先

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

いま Preview URL を使っているか確認する

sf auth show --json

ここで effectiveBaseUrl が Preview URL なら、切り替えてください。

切り替え手順

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

job ごとに設定を分けたいなら、config path も分けてください。

export SIGNAL_FOUNDRY_CONFIG_PATH="$PWD/.signal-foundry/config.json"

失敗の見え方

Preview URL 問題は、次のように見えることがあります。

  • 404 not_found
  • 401 のような認証失敗
  • HTML が返ってきて CLI が期待した JSON でない

原因が分かりにくいので、まず sf auth show --json で effectiveBaseUrl を見るのが最短です。

このページの内容

何が問題かPR smoke だけ Preview を使う場合正しく使う接続先いま Preview URL を使っているか確認する切り替え手順失敗の見え方