Skip to main content
POST
Python

Authorizations

x-api-key
string
header
required

Body

application/json
entity_type
enum<string>
required

Type of entity to search for.

Available options:
company,
people
objective
string
required

Natural language description of target entities.

match_limit
integer
default:100

Maximum number of candidates to return. Must be between 5 and 1000 (inclusive). May return fewer results. Defaults to 100.

Required range: 5 <= x <= 1000

Response

Successful Response

candidate_set_id
string
required

Candidate set request ID. Example: candidate_set_cad0a6d2dec046bd95ae900527d880e7

candidates
CandidateItem · object[]
required

Ranked list of entity candidates.