Skip to main content
Start a matching run

Authorizations

x-partner-key
string
header
required

Partner API key: vpk_live_ + 48 lowercase hex. Server-side only.

x-vort-org
string
header
required

Customer org token: vot_ + 48 lowercase hex, from /activations/redeem. Server-side only.

Headers

x-vort-lang
enum<string>

Language of notices and messages. Defaults to the partner default.

Available options:
he,
en

Body

application/json
job_external_id
string
required
acting_user_external_id
string
required
target_count
integer
required
Required range: x >= 1
requirements
object[]

In display order; indexes are 0-based positions. At most 3 with kind must. When omitted, Vort derives requirements from the job description.

Response

Run started.

run_id
string<uuid>
required
status
string
required
Allowed value: "running"
warnings
object[]
required