Skip to main content
POST
entities.find-refresh

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 - the same search you ran before.

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 new match must satisfy, as in entities.find.

Required array length: 1 - 6 elements
exclude
object[]
required

Up to 1000 entities earlier runs already returned, each as its name and URL. The search skips these and looks only for what is new.

Maximum array length: 1000
limit
number

How many new matches to look for, 1 to 50. Default 10.

Required range: x >= 1
fields
object

Optional JSON Schema of extra fields to fill in per new match, as in entities.find, at most 8000 characters as JSON.

quality
enum<string>
default:fast

"fast" searches broadly; "standard" searches deeper; "deep" is the dearest and most thorough. Default "fast". Priced like entities.find: a fixed price per run plus a price per new match.

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.