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

API リファレンス

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

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

POST /lists/estimate

会社群を保存する前に、対象数、条件解釈、必要 credit を見積もる endpoint です。

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

POST /api/signal-foundry/lists/estimate は、自然文の会社条件を保存前に解釈し、対象数と materialize credit を返します。

契約サマリー

FieldValue
MethodPOST
Path/api/signal-foundry/lists/estimate
Authproduction は API key 必須
Usagerequest usage に count
Credit消費しない
CLIsf list estimate "<query>" --json

リクエスト

リクエストボディ

{
  "query": "上場企業のうち、売上100億以上"
}

例

curl -s "$SIGNAL_FOUNDRY_BASE_URL/api/signal-foundry/lists/estimate" \
  -H "Authorization: Bearer <SIGNAL_FOUNDRY_API_KEY>" \
  -H "Content-Type: application/json" \
  --data '{
    "query": "上場企業のうち、売上100億以上"
  }'

CLI equivalent:

sf list estimate "上場企業のうち、売上100億以上" --json

レスポンス

中心フィールド

  • estimate.estimate_id
  • resolved_definition
  • counts.matched_companies
  • billing.materialize.estimated_credits
  • unsupported_conditions
  • weak_conditions
  • next_actions

例

{
  "estimate": {
    "estimate_id": "est_123"
  },
  "resolved_definition": {
    "status": "supported",
    "warnings": []
  },
  "counts": {
    "matched_companies": 42
  },
  "billing": {
    "materialize": {
      "estimated_credits": 42
    }
  },
  "unsupported_conditions": [],
  "weak_conditions": [],
  "next_actions": [
    "sf list candidates --from-estimate est_123 --json",
    "sf list materialize --from-estimate est_123 --execute --max-credits 42 --json"
  ]
}

unsupported_conditions や weak_conditions が残る場合は、materialize に進む前に query を分け直してください。

エラー

CodeHTTP復旧方法
invalid_request400query を必須文字列として渡す
invalid_query400条件を短くし、supported な filter に分ける
rate_limit_exceeded429Retry-After まで待つ

次に進む

候補 preview を見る場合は GET /lists/candidates に進みます。

このページの内容

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