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

API リファレンス

認証、利用上限、主要 endpoint を実行単位で確認します。

API 概要
会社検索会社プロフィール構造化 Company Query会社の観測データ開示一覧求人検索会社の事例データ建設業許可検索クレジット残高クレジット利用サマリーフィードバックAPI
API リファレンス

GET /companies/{companyId}/cases

1 社に紐づく事例・顧客関係・施工/案件 evidence の contract を説明します。

このページの内容6項目
契約サマリーリクエストクエリパラメータレスポンスBillingエラーと復旧方法

GET /api/signal-foundry/companies/{companyId}/cases は、既存 observation から 1 社の事例、顧客関係、施工/案件 evidence を返します。

この endpoint は read surface です。新規 crawl、render、外部検索、全文取得で新しい evidence を作る surface ではありません。

契約サマリー

FieldValue
MethodGET
Path/api/signal-foundry/companies/{companyId}/cases
Authproduction は API key または OAuth bearer token 必須
Usagerequest usage と rate limit に count
Credit1 request credit
CLIsf company cases <companyId> --json

request credit は response header で返ります。

HeaderMeaning
x-signal-foundry-request-credits-usedこの request で消費した credit。通常は 1
x-signal-foundry-request-credit-deduplicatedidempotency により既存 event を再利用したか

リクエスト

curl -s \
  -H "Authorization: Bearer <SIGNAL_FOUNDRY_API_KEY>" \
  "https://signal-foundry.app/api/signal-foundry/companies/jpx_6836/cases?limit=5&relation_tier=all"

{companyId} は先に GET /companies または sf company search ... --json で解決します。

クエリパラメータ

ParamTypeDefaultNotes
limitinteger25各 section の共通 limit
case_limitinteger25case_studies の limit
customer_limitinteger25customer_relations の limit
project_limitinteger25projects の limit
offsetinteger00..10000
relation_tierenumhigh_confhigh_conf, primary, all

レスポンス

まず見る key:

  • company.company_id
  • customer_relations[].customer.company_name
  • customer_relations[].relation_tier
  • case_studies[].page_title
  • projects[].project_name
  • *.url
  • meta.coverage_warnings
  • meta.request_credit.credits_used (CLI JSON)
  • meta.returned_case_studies
  • meta.returned_customer_relations
  • meta.returned_projects
{
  "object": "company_cases",
  "company": {
    "company_id": "jpx_6836",
    "display_name": "ぷらっとホーム株式会社"
  },
  "customer_relations": [],
  "case_studies": [],
  "projects": [],
  "meta": {
    "coverage_warnings": [
      {
        "code": "company_cases_coverage_gap",
        "status": "no_data"
      }
    ],
    "returned_case_studies": 0,
    "returned_customer_relations": 0,
    "returned_projects": 0
  }
}

case_studies、customer_relations、projects がすべて 0 件でも、meta.coverage_warnings がある場合は「事例なし」と断定しません。website / observations の coverage gap、または未観測の状態として扱います。

Billing

この endpoint は既存 evidence を読む data request なので、API / CLI で呼ぶと 1 request credit です。

credit summary では usage.api_request ledger event が meterType = api_request、usageKey = api.data_request として出ます。

新規 crawl、crawl4ai / browser render、外部検索、全文取得として新しい evidence を作る場合は、他の source と同じ credit-consuming write です。実行前に利用量上限を明示してください。

エラーと復旧方法

Error原因復旧
not_foundproduction で API key / OAuth なしsf login するか API key を付ける
company_not_foundcompanyId が解決できないsf company search "<会社名>" --json で company_id を確認する
credit_balance_insufficientrequest credit 残高不足sf credits balance --json で grant 残高を確認する
rate_limit_exceededAPI key / OAuth subject の rate limitretry-after header の秒数待って再試行する
0 件 + meta.coverage_warningscase signal の coverage gapsf company observations <companyId> --limit 5 --json と Company Card の source coverage を確認する

このページの内容

契約サマリーリクエストクエリパラメータレスポンスBillingエラーと復旧方法