Skip to main content
POST
companies.enrich-bulk

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
rows
object[]
required

The companies to enrich, each with your own row id. Every row must use the same identifier kind (all domains or all profile URLs). At most 100.

Required array length: 1 - 100 elements
maxRows
integer
default:100

Cost ceiling: the job refuses to start unless your credit covers 2 per row, and rows above it are rejected. Default 100.

Required range: 1 <= x <= 100

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.