Skip to main content
POST
entities.find-plan

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 are considering searching for, in plain words, up to 5000 characters.

Required string length: 1 - 5000

Response

The result

objective
string
required

The objective the search would run with.

entityType
enum<string>
required

The kind of entity the search would look for.

Available options:
company,
person
conditions
object[]
required

The match conditions the search would evaluate.

depth
enum<string>

How deep the planned search would go: fast $0.25 plus $0.03 per match, standard $2.00 plus $0.15, deep $10.00 plus $1.00.

Available options:
fast,
standard,
deep
matchLimit
number

The most matches the planned search would evaluate for.