Quickstart

You’ll set up a Role, get a candidate into an interview, and see a scored transcript within ~2 minutes of them finishing. Pick the path that fits you.

By UI (no code)
By API

The fastest path — for hiring managers, recruiters, and L&D teams who never want to touch an API.

Create a workspace

Pick a Role

Open Roles and choose a calibrated starter (Software Engineer, Sales Rep, Customer Support…) — or build your own. See Roles. New here? Try a ready-made cookbook recipe.

Get a candidate in

Either click Add under Participants to invite someone directly, or share the Role’s public apply link and let people apply themselves. Either way they verify by email and the AI interviews them.

Review the scorecard

When the session completes, a full scorecard — per-dimension scores, recommendation, transcript, recording — appears on the participant’s profile. Share it with your panel via a no-login link.

For developers integrating intervyo.ai into your own product or ATS. Full walkthrough: Hiring, step by step.

Get an API key

In the dashboard, go to Developer → API Keys and create a key scoped to participants:write and sessions:write. See Authentication.

Set up your environment

export INTERVYO_API_KEY="iv_live_…"
export ROLE_ID="ce1cd564-..."   # from your Roles page
export TEAM_SLUG="your-team-slug"

Create a participant

Sessions belong to a participant, so create one first.

curl -X POST "https://www.intervyo.ai/api/v1/participants?accountSlug=$TEAM_SLUG" \
  -H "x-api-key: $INTERVYO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Ada Lovelace",
    "email": "ada@example.com",
    "role_id": "'"$ROLE_ID"'"
  }'

const res = await fetch(
  `https://www.intervyo.ai/api/v1/participants?accountSlug=${process.env.TEAM_SLUG}`,
  {
    method: "POST",
    headers: {
      "x-api-key": process.env.INTERVYO_API_KEY!,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      name: "Ada Lovelace",
      email: "ada@example.com",
      role_id: process.env.ROLE_ID,
    }),
  },
);
const { data } = await res.json();
const candidateId = data.id;

import os, requests

res = requests.post(
    "https://www.intervyo.ai/api/v1/participants",
    params={"accountSlug": os.environ["TEAM_SLUG"]},
    headers={"x-api-key": os.environ["INTERVYO_API_KEY"]},
    json={
        "name": "Ada Lovelace",
        "email": "ada@example.com",
        "role_id": os.environ["ROLE_ID"],
    },
)
candidate_id = res.json()["data"]["id"]

Save the returned id as your candidate_id.

Schedule the session

The invite email is sent automatically.

curl -X POST "https://www.intervyo.ai/api/v1/sessions?accountSlug=$TEAM_SLUG" \
  -H "x-api-key: $INTERVYO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "candidate_id": "<candidate_id-from-previous-step>",
    "role_id": "'"$ROLE_ID"'",
    "stage": "screen",
    "idempotency_key": "quickstart-ada-screen"
  }'

The response includes a join_url (and confirms the invite was emailed).

Receive the scorecard

Configure a webhook to get session.completed the moment the interview ends — or poll GET /api/v1/sessions/{id} until status is completed. Webhooks are strongly preferred; the wait is otherwise unbounded.

What just happened

The AI ran your rubric

Every dimension on the Interviewer was scored against the transcript, with per-dimension reasoning and citations.

Authenticity signals captured

Tab-switch, paste, and voice-spoofing signals surface on the dashboard for your judgment — never used to silently reject.

Recording archived

Audio and transcript stored in encrypted, region-aware buckets with presigned access. Retention follows your workspace policy.

Webhook delivered

If configured, your endpoint received the event with the full scorecard, HMAC-signed, with retries on failure.

Next: tune what the AI assesses in your Interviewer, or add a second Round so candidates auto-progress on a pass.

Get Started

Concepts

Cookbook

Tutorials

Guides

MCP

What just happened

The AI ran your rubric

Authenticity signals captured

Recording archived

Webhook delivered

​What just happened

The AI ran your rubric

Authenticity signals captured

Recording archived

Webhook delivered

What just happened