OpenAPI Endpoint Inventory

このページは、OpenAPI 化の前に固定する endpoint inventory です。

OpenAPI spec は external integration / SDK generation には有効です。ただし現時点では、CLI JSON contract と docs の recovery path を正本にします。OpenAPI は deferred で、endpoint visibility、auth、credit tag、response schema owner が揃ってから公開 contract にします。

契約サマリー

リクエスト

この page 自体は API endpoint ではありません。API を直接組み込む前に、該当 endpoint の docs と CLI equivalent を確認します。

最小の read request:

curl -s "$SIGNAL_FOUNDRY_BASE_URL/api/signal-foundry/companies?q=7203" \
  -H "Authorization: Bearer <SIGNAL_FOUNDRY_API_KEY>"

同じ操作を CLI で先に通します。

sf companies search 7203 --json

レスポンス

endpoint ごとの response schema は各 docs page を正本にします。agent はまず次の種類の key を確認します。

{
  "companies": [
    {
      "company": {
        "company_id": "jpx_7203",
        "display_name": "Toyota Motor Corporation"
      },
      "query_match": {
        "identifier_matched": true
      }
    }
  ],
  "meta": {
    "returned_companies": 1
  }
}

OpenAPI 公開前に、success response と error envelope の schema owner を endpoint group ごとに固定します。

Tag taxonomy

production は API key 必須です。通常 accountId / account_id は送らず、API key の team workspace scope に任せます。

Public read endpoints

List workspace endpoints

public_write_credit は execute: true、maxCredits、Idempotency-Key を要求します。CLI では --execute --max-credits <n> --json を使います。

Source endpoints

Research / feedback endpoints

Non-public routes

次の routes は public OpenAPI spec には入れません。

non_public は、外部 integration contract として support しない route です。公開 docs では CLI / workflow / API overview から辿れる route を正本にします。

OpenAPI readiness checklist

次に読むページ

• API overview: API リファレンス
• data provenance: Data Provenance
• credit contract: Credit Schedule
• direct API auth: API Key Authentication

復旧方法