Skip to main content
POST
Launch a search

Authorizations

Authorization
string
header
required

An API key from Settings → Usage → API (rvc_live_…).

Headers

Idempotency-Key
string

8 to 160 printable characters; reuse it to retry safely.

Path Parameters

projectId
string
required

A project id

Body

application/json
criteria
object

See the Criteria guide and GET /reference/criteria for every field.

jd_text
string
Minimum string length: 40
database_only
boolean

Search only the workspace's candidates on file. Uses no shortlist.

target_count
integer
Required range: 1 <= x <= 100

Response

A retry with the same Idempotency-Key and request: the first search, with reused true.

data
object
meta
object