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

API リファレンス

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

API 概要
OpenAPI Inventory会社検索会社プロフィール会社の観測データ開示一覧開示詳細開示比較観測データ検索ソースAPIリストAPIリスト見積もりリスト候補確認リスト保存リストEnrichmentリストExport調査アイテムクレジット残高クレジット利用サマリーフィードバックAPI外部調査API
API リファレンス

POST /lists/materialize

estimate を明示的な credit cap 付きで saved List に変える endpoint です。

このページの内容10項目
契約サマリーリクエストHeadersリクエストボディ例レスポンス中心フィールド例エラー次に進む

POST /api/signal-foundry/lists/materialize は、保存前の estimate を saved List に変換します。credit-consuming write なので、execute: true、maxCredits、Idempotency-Key を付けます。

契約サマリー

FieldValue
MethodPOST
Path/api/signal-foundry/lists/materialize
Authproduction は API key 必須
Usagerequest usage に count
Creditsaved row の Basic credit
CLIsf list materialize --from-estimate <estimateId> --execute --max-credits <n> --json

リクエスト

Headers

HeaderRequiredNotes
AuthorizationyesBearer <SIGNAL_FOUNDRY_API_KEY>
Content-Typeyesapplication/json
Idempotency-Keyyesretry 時の二重消費を避ける

リクエストボディ

{
  "estimateId": "est_123",
  "name": "売上100億以上の上場企業",
  "execute": true,
  "maxCredits": 42
}

例

curl -s "$SIGNAL_FOUNDRY_BASE_URL/api/signal-foundry/lists/materialize" \
  -H "Authorization: Bearer <SIGNAL_FOUNDRY_API_KEY>" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: list-materialize-20260501-001" \
  --data '{
    "estimateId": "est_123",
    "name": "売上100億以上の上場企業",
    "execute": true,
    "maxCredits": 42
  }'

CLI equivalent:

sf list materialize --from-estimate est_123 --name "売上100億以上の上場企業" --execute --max-credits 42 --json

レスポンス

中心フィールド

  • list.list_id
  • list.row_count
  • billing.credits_used
  • billing.max_credits
  • input.estimate_id
  • idempotency_key

例

{
  "list": {
    "list_id": "00000000-0000-4000-8000-000000000000",
    "name": "売上100億以上の上場企業",
    "row_count": 42
  },
  "billing": {
    "credits_used": 42,
    "max_credits": 42
  },
  "input": {
    "estimate_id": "est_123"
  },
  "idempotency_key": "list-materialize-20260501-001"
}

エラー

CodeHTTP復旧方法
estimate_not_found404estimate からやり直す
max_credits_required400maxCredits を付ける
max_credits_exceeded402estimate response の credit 以上を指定するか query を狭める
credit_balance_insufficient402GET /credits/balance を確認

次に進む

追加情報を足す場合は Lists Enrichments に進みます。CSV が必要なら Lists Export を使います。

このページの内容

契約サマリーリクエストHeadersリクエストボディ例レスポンス中心フィールド例エラー次に進む