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

概要

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

はじめに
sf CLI をインストールクイックスタート会社IDの見方データの出所カバレッジとタグ
認証
認証設定APIキーのライフサイクル利用状況の見方APIキー認証アカウントスコープは通常不要レート制限とエラー
請求
利用プラン利用量の計測クレジット表
CLI
CLI 概要CLI 認証基本コマンド会社検索求人検索会社・事例・観測・開示建設業許可検索ヘルプとエラーコマンドとフラグCLI 更新
トラブルシュート
会社が見つからないとき認証・接続・制限エラー低ヒット検索の見直し方プレビューURLの注意クレジットと maxCredits の失敗
認証

APIキー設定

API キー設定画面で何ができるかと、service 認証情報 が必要なときの運用をまとめます。

このページの内容5項目
できることservice 認証情報 が必要なときにやること運用ルール権限利用量画面で見えるもの

API キーは、Signal Foundry ワークスペースの API キー設定画面から管理します。通常の人間 / エージェント接続は sf login です。API key は、プロダクト組み込み、backend job、.env / secret store から直接 HTTP API を呼ぶ service 認証情報 として使います。

  • チームアカウント: /home/<account-id>/settings/api-keys

個人アカウントの設定画面は既存ユーザーや内部検証のために残る場合がありますが、billing、クレジット、共有リストを運用する正面入口は チームワークスペースです。

できること

  • 名前付きで API キーを発行する
  • 任意で有効期限を付ける
  • 既存キーを revoke する
  • 既存キーを rotate する
  • 直近 30 日の利用量を確認する

service 認証情報 が必要なときにやること

  1. チームワークスペースのAPI キー設定画面を開く
  2. 平文キーをその場で保存する
  3. product backend、job 実行環境、CI などの secret store に保存する
  4. direct API request の疎通を確認する

平文キーは初回表示後に再表示できません。docs、issue、prompt、shell history、エージェントの会話ログには書かないでください。

運用ルール

  • 用途ごとにキーを分ける
  • 人間/エージェント onboarding は sf login を使う
  • 長期利用しないキーは revoke する
  • 共有キーは rotate 前提で配る
  • sf_live_ で始まる平文キーは初回表示時にだけ控える
  • Preview URL を接続先にしない

権限

チームアカウントでは settings.manage 権限を持つメンバーが管理します。1 人で使う場合も、自分が owner の チームワークスペースでキーを作ります。

利用量画面で見えるもの

  • request 数
  • 利用 endpoint 数
  • response bytes
  • 最終利用時刻
  • endpoint 別の内訳
  • キーごとの利用状況と状態

詳しい運用は次の 2 ページを参照してください。

  • API Key Lifecycle
  • Usage Summary

このページの内容

できることservice 認証情報 が必要なときにやること運用ルール権限利用量画面で見えるもの