Skip to main content
POST
People Intelligence (Bulk)

Headers

Idempotency-Key
string | null

Optional idempotency key for retry-safe bulk submissions.

x-api-key
string | null

Query Parameters

cost_units
enum<string>
default:cents

Response cost unit.

Available options:
cents,
credits

Body

multipart/form-data
file
string
required

CSV, JSON, JSONL, or NDJSON file (max 100 MB / 100,000 rows).

config
string
required

JSON-encoded people enrichment config (PeopleBulkIntelligenceConfig schema; max 300000 characters).

Response

Successful Response

Response when a bulk intelligence job is started.

task_id
string
required

Job ID. Poll GET /job-status/{task_id}; on completion the response includes signed download links for result files.

status
string
required

Job status, typically 'RUNNING'.

row_count
integer | null

Number of parsed input rows; omitted on idempotent replays.

estimated_cost_cents
integer | null

Estimated job cost in cents (rows × per-row tier price). A floor: options like find_people can bill more. Omitted on idempotent replays. Returned when cost_units=cents.

estimated_cost_credits
number | null

Estimated job cost in credits. Returned when cost_units=credits.

already_started
boolean | null

True when the request was deduplicated via Idempotency-Key header.