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

API Key Authentication

Signal Foundry API の認証ヘッダーと基本的な呼び出し方を説明します。

このページの内容2項目
例動作

Signal Foundry API は、次のどちらかで認証できます。

  • x-api-key: <API_KEY>
  • Authorization: Bearer <API_KEY>

両方を同時に送る場合は、同じキーである必要があります。

例

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

動作

  • 正しいキーなら auth_mode=api_key で記録される
  • 無効なキーなら 401 invalid_api_key
  • revoke 済みなら 401 api_key_revoked
  • rotate 済みなら 401 api_key_rotated
  • 期限切れなら 401 api_key_expired
  • minute/day 上限を超えると 429 rate_limit_exceeded

公開利用では API キー前提です。正規接続先には https://signal-foundry.app を使ってください。

このページは current read API の認証方法だけを扱います。browser session を primary auth とする設計や、書き込み系 API の将来仕様までは含みません。

このページの内容

例動作