Skip to main content
POST
entities.find

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
objective
string
required

The entities you want, in plain words, up to 5000 characters.

Required string length: 1 - 5000
entityType
enum<string>
required

The kind of entity to find.

Available options:
company,
person
conditions
object[]
required

1 to 6 conditions every match must satisfy. Each match reports whether each condition held.

Required array length: 1 - 6 elements
limit
number

How many matches to return, 1 to 50. Default 10.

Required range: x >= 1
fields
object

Optional JSON Schema of extra fields to fill in per match: an object of 1-8 named scalar, enum or short-array fields, at most 8000 characters as JSON. Each field comes back with its value, sources, confidence and reasoning, or as missing with a reason.

preview
boolean
default:false

Try the objective and conditions on 5 to 10 candidates first, for a flat $0.10 (plus the per-match field price when fields are requested). Returns only the matches among those candidates, so it may return few or none. The limit is capped to 10.

quality
enum<string>
default:fast

"fast" finds broad matches cheaply; "standard" searches deeper for harder objectives; "deep" is the dearest and most thorough, for rare or hard-to-verify matches. Default "fast". A deep run costs $10 plus $1 per match (plus $0.10 per match with extra fields), so at the 50-match limit up to $60, or $65 with fields - the job starts only when the credit covers that.

Available options:
fast,
standard,
deep

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.