Participants

A participant is the person being interviewed — a candidate, a trainee, or a student. You create the participant first, then book interviews (sessions) for them. A participant belongs to one template. So the same email can show up as two different participants under two different templates.

Every field, in plain words

string

required

The person’s full name.

string

required

Their email. Must be unique in your account. The invite is sent here.

uuid

The role you’re checking them against.

string

The person’s ID in your system (ATS, LMS, app). It comes back in every webhook, so you can match results without storing our IDs.

object

Basic info to help the AI: { title, organization, experienceLevel, location }.

object

More detail: { skills: [...], education, languages: [...] }.

url

A link to their resume. The AI reads it so it can ask better questions.

string[]

Labels you choose, like ["senior", "remote"], to find people later.

Add one, step by step

Dashboard (UI)
API

Open Participants

In the team dashboard, click Participants in the left sidebar.

Add a participant

Click Add (or New participant).

Fill in name and email

These two are required. The email is where the interview invite is sent.

Pick the Role

Choose the Role this person is being evaluated for.

Save

Save. The participant appears in the list, ready to schedule.

Pick the template

Decide which role_id this person is for.

Fill in name and email

These two are required. The email gets the invite.

Add your own ID

Set external_id to the person’s ID in your system. This saves you pain later.

Send the request

curl -X POST "https://www.intervyo.ai/api/v1/participants?accountSlug=<slug>" \
  -H "x-api-key: iv_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Jane Smith",
    "email": "jane@example.com",
    "external_id": "greenhouse-8821",
    "role_id": "ce1cd564-...",
    "profile": { "title": "Software Engineer", "experienceLevel": "senior" }
  }'

Save the ID

The response gives you a participant id. Use it to schedule a session.

Have a big list? Use the bulk import endpoint to add up to 500 people in one call. Duplicate emails are skipped automatically.

Examples for each use case

Hiring
Training
Mock interview

A candidate from your ATS, with a resume.

{
  "name": "Jane Smith",
  "email": "jane@example.com",
  "external_id": "greenhouse-8821",
  "role_id": "ce1cd564-...",
  "profile": { "title": "Software Engineer", "experienceLevel": "senior" },
  "resume_url": "https://.../jane-resume.pdf",
  "tags": ["senior", "backend"]
}

An employee learning a skill. The ID is their HR record.

{
  "name": "Carlos Reyes",
  "email": "carlos@yourco.com",
  "external_id": "workday-44120",
  "role_id": "ce1cd564-...",
  "profile": { "title": "Account Executive", "organization": "West Region" },
  "tags": ["q3-cohort"]
}

A student practicing. Keep it light — just enough to say hello.

{
  "name": "Priya Patel",
  "email": "priya@student.edu",
  "external_id": "user_98213",
  "role_id": "ce1cd564-...",
  "profile": { "title": "New Grad", "experienceLevel": "entry" }
}

Sessions

Book the actual interview for your participant.

Create a participant (API)

The full endpoint reference.

Get Started

Concepts

Cookbook

Tutorials

Guides

MCP

Every field, in plain words

Add one, step by step

Examples for each use case

Next

Sessions

Create a participant (API)

​Every field, in plain words

​Add one, step by step

​Examples for each use case

​Next

Sessions

Create a participant (API)

Every field, in plain words

Add one, step by step

Examples for each use case

Next