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

API リファレンス

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

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

POST /lists/{listId}/enrichments

saved List に website / Parallel enrichment を見積もり、実行する endpoint pair です。

このページの内容9項目
契約サマリーリクエストEstimateRunレスポンスEstimate responseRun responseエラー次に進む

List enrichment は、saved List に追加 column / evidence を足す endpoint pair です。先に estimate を実行し、必要 credit を確認してから run に進みます。Parallel は candidate set を saved List に固定した後の external enrichment です。broad search / Find All の入口にはしません。

契約サマリー

FieldEstimateRun
MethodPOSTPOST
Path/api/signal-foundry/lists/{listId}/enrichments/estimate/api/signal-foundry/lists/{listId}/enrichments/run
Authproduction は API key 必須production は API key 必須
Credit消費しないfound row 分
CLIsf list enrich <listId> --source website --estimate --json / sf list enrich <listId> --source parallel --estimate --limit <n> --jsonsf list enrich <listId> --source website --execute --max-credits <n> --json / sf list enrich <listId> --source parallel --execute --limit <n> --max-credits <n> --json

リクエスト

Estimate

curl -s "$SIGNAL_FOUNDRY_BASE_URL/api/signal-foundry/lists/00000000-0000-4000-8000-000000000000/enrichments/estimate" \
  -H "Authorization: Bearer <SIGNAL_FOUNDRY_API_KEY>" \
  -H "Content-Type: application/json" \
  --data '{
    "source": "website"
  }'

CLI equivalent:

sf list enrich 00000000-0000-4000-8000-000000000000 --source website --estimate --json
sf list enrich 00000000-0000-4000-8000-000000000000 --source parallel --estimate --limit 10 --json

Run

credit-consuming write です。execute: true、maxCredits、Idempotency-Key を付けます。

curl -s "$SIGNAL_FOUNDRY_BASE_URL/api/signal-foundry/lists/00000000-0000-4000-8000-000000000000/enrichments/run" \
  -H "Authorization: Bearer <SIGNAL_FOUNDRY_API_KEY>" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: list-enrich-20260501-001" \
  --data '{
    "source": "website",
    "execute": true,
    "maxCredits": 35
  }'

CLI equivalent:

sf list enrich 00000000-0000-4000-8000-000000000000 --source website --execute --max-credits 35 --json
sf list enrich 00000000-0000-4000-8000-000000000000 --source parallel --execute --limit 10 --max-credits 10 --json

レスポンス

Estimate response

中心フィールド:

  • estimate.estimated_target_companies
  • estimate.estimated_max_credits
  • estimate.reusable_existing_companies
  • preview_rows
  • billing.charges_only_found
  • Parallel の場合は limit と external source scope
{
  "estimate": {
    "estimated_target_companies": 42,
    "estimated_max_credits": 35,
    "reusable_existing_companies": 7
  },
  "preview_rows": [
    {
      "company_id": "jpx_7203",
      "already_enriched": true
    }
  ],
  "billing": {
    "charges_only_found": true
  }
}

Run response

中心フィールド:

  • run.run_id
  • run.found_count
  • run.not_found_count
  • run.no_data_count
  • run.skipped_count
  • billing.credits_used
  • billing.charges_only_found
  • Parallel の場合は saved row に parallel_enrichment_* export columns の元になる summary / query / urls / signals が残る
{
  "run": {
    "run_id": "run_123",
    "found_count": 35,
    "not_found_count": 3,
    "no_data_count": 2,
    "skipped_count": 2
  },
  "billing": {
    "charges_only_found": true,
    "credits_used": 35
  }
}

website enrichment では billing.charges_only_found が true になり、billing.credits_used は run.found_count を超えません。not_found / no_data / skipped row は課金対象外です。

エラー

CodeHTTP復旧方法
list_not_found404listId を確認
max_credits_required400run に maxCredits を付ける
max_credits_exceeded402estimate の estimated_max_credits 以上を指定する
credit_balance_insufficient402GET /credits/balance を確認

次に進む

enrichment 後に CSV が必要なら Lists Export に進みます。

このページの内容

契約サマリーリクエストEstimateRunレスポンスEstimate responseRun responseエラー次に進む