API リファレンス
POST /lists/estimate
会社群を保存する前に、対象数、条件解釈、必要 credit を見積もる endpoint です。
このページの内容9項目
POST /api/signal-foundry/lists/estimate は、自然文の会社条件を保存前に解釈し、対象数と materialize credit を返します。
契約サマリー
| Field | Value |
|---|---|
| Method | POST |
| Path | /api/signal-foundry/lists/estimate |
| Auth | production は API key 必須 |
| Usage | request usage に count |
| Credit | 消費しない |
| CLI | sf 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_idresolved_definitioncounts.matched_companiesbilling.materialize.estimated_creditsunsupported_conditionsweak_conditionsnext_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 を分け直してください。
エラー
| Code | HTTP | 復旧方法 |
|---|---|---|
invalid_request | 400 | query を必須文字列として渡す |
invalid_query | 400 | 条件を短くし、supported な filter に分ける |
rate_limit_exceeded | 429 | Retry-After まで待つ |
次に進む
候補 preview を見る場合は GET /lists/candidates に進みます。