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 の失敗
認証

Authentication Overview

Signal Foundry の認証は workspace login、team workspace、API key の順に進めます。初回ユーザーが install 後に何をすればよいかをここで固定します。

このページの内容7項目
install 後にやること役割分担覚えておく前提最初に読む順番Claude Code / Codex で使うときの原則この docs が扱うものこの docs がまだ前提にしていないもの

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

  • workspace login: ブラウザで API キーを発行するためのログイン
  • team workspace: API キー、List、credit、billing を束ねる account scope
  • API 利用認証: CLI / API / agent が使う Signal Foundry API キー

ブラウザへログインするだけでは API は使えません。公開利用で重要なのは、team workspace で API キーを発行し、そのキーを CLI / agent に保存することです。

install 後にやること

  1. https://signal-foundry.app にサインアップまたはサインインする
  2. 最初の team workspace を作成する
  3. team workspace の API キー設定画面でキーを 1 本発行する
  4. sf auth setup --base-url https://signal-foundry.app を実行する
  5. sf auth show --json で有効設定を確認する
  6. sf companies search 7203 --json で最初の疎通確認をする

この 6 手で auth は完了です。

役割分担

  • UI に入る: workspace login
  • 通常の利用単位を作る: team workspace
  • API キーを作る: team workspace の API キー設定画面
  • API を叩く: x-api-key または Authorization: Bearer
  • 利用量を確認する: usage summary

覚えておく前提

  • 公開利用は API キー前提です
  • API キーは account 単位で発行されます
  • 通常の account scope は team workspace です
  • account_id は通常不要です
  • Preview URL は正規の接続先にしません

最初に読む順番

  1. API Key Settings
  2. API Key Lifecycle
  3. Usage Summary
  4. Quick Start

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

  • API キーは chat に貼らず、sf auth setup の隠し入力で保存する
  • agent には sf auth show --json から始めさせる
  • 失敗時は error.hint と error.suggested_next_commands を優先する

この docs が扱うもの

  • API キーの作成、ローテーション、失効、期限設定
  • API キーの送信方法
  • usage summary の見方
  • install 後の最短 auth フロー

この docs がまだ前提にしていないもの

  • browser session を primary auth にする API 利用
  • 個人 account を課金単位にする運用
  • 複雑な identity federation
  • service account や細粒度 permission model

初回導入では、まず team workspace の API キー 1 本で list estimate まで成功させることだけを考えてください。

このページの内容

install 後にやること役割分担覚えておく前提最初に読む順番Claude Code / Codex で使うときの原則この docs が扱うものこの docs がまだ前提にしていないもの