GET /companies/{companyId}/cases
1 社に紐づく事例・顧客関係・施工/案件 evidence の contract を説明します。
このページの内容6項目
GET /api/signal-foundry/companies/{companyId}/cases は、既存 observation から 1 社の事例、顧客関係、施工/案件 evidence を返します。
この endpoint は read surface です。新規 crawl、render、外部検索、全文取得で新しい evidence を作る surface ではありません。
契約サマリー
| Field | Value |
|---|---|
| Method | GET |
| Path | /api/signal-foundry/companies/{companyId}/cases |
| Auth | production は API key または OAuth bearer token 必須 |
| Usage | request usage と rate limit に count |
| Credit | 1 request credit |
| CLI | sf company cases <companyId> --json |
request credit は response header で返ります。
| Header | Meaning |
|---|---|
x-signal-foundry-request-credits-used | この request で消費した credit。通常は 1 |
x-signal-foundry-request-credit-deduplicated | idempotency により既存 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 で解決します。
クエリパラメータ
| Param | Type | Default | Notes |
|---|---|---|---|
limit | integer | 25 | 各 section の共通 limit |
case_limit | integer | 25 | case_studies の limit |
customer_limit | integer | 25 | customer_relations の limit |
project_limit | integer | 25 | projects の limit |
offset | integer | 0 | 0..10000 |
relation_tier | enum | high_conf | high_conf, primary, all |
レスポンス
まず見る key:
company.company_idcustomer_relations[].customer.company_namecustomer_relations[].relation_tiercase_studies[].page_titleprojects[].project_name*.urlmeta.coverage_warningsmeta.request_credit.credits_used(CLI JSON)meta.returned_case_studiesmeta.returned_customer_relationsmeta.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_found | production で API key / OAuth なし | sf login するか API key を付ける |
company_not_found | companyId が解決できない | sf company search "<会社名>" --json で company_id を確認する |
credit_balance_insufficient | request credit 残高不足 | sf credits balance --json で grant 残高を確認する |
rate_limit_exceeded | API key / OAuth subject の rate limit | retry-after header の秒数待って再試行する |
0 件 + meta.coverage_warnings | case signal の coverage gap | sf company observations <companyId> --limit 5 --json と Company Card の source coverage を確認する |