Skip to main content
POST
/
api
/
v1
/
participants
Create participant
curl --request POST \
  --url https://www.intervyo.ai/api/v1/participants \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "email": "<string>",
  "evaluation_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "<string>",
  "phone": "<string>",
  "tags": [
    "<string>"
  ],
  "profile": {},
  "background": {},
  "resume_url": "<string>",
  "pipeline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {},
  "status": "<string>"
}
'
{
  "error": "<string>",
  "issues": [
    {}
  ]
}

Authorizations

​
x-api-key
string
header
required

API key with the iv_live_ prefix. Create one under Developer → API Keys.

Body

application/json
​
name
string
required

Full name

​
email
string
required

Email — unique per account

​
evaluation_template_id
string<uuid>

Evaluation template to associate

​
external_id
string

Your ATS / system ID — echoed back in all webhook payloads

​
phone
string

Phone number

​
tags
string[]

Arbitrary labels, e.g. ["senior", "remote"]

​
profile
object

{ title, organization, experienceLevel, location }

​
background
object

{ skills: string[], education, languages: string[] }

​
resume_url
string<uri>

Publicly accessible resume URL — triggers vector extraction

​
pipeline_id
string<uuid>

Assign to a hiring pipeline on creation

​
metadata
object

Arbitrary key-value store

​
status
string

Initial status (default: active)

Response

Success

Last modified on June 3, 2026