# intervyo.ai

> Developer documentation for intervyo.ai — the AI interviewer for hiring, sales training, and research.

## Docs

- [Execute code against test cases](https://intervyo.ai/docs/api-reference/code-execution/post-code-execute.md)
- [Delete interviewer](https://intervyo.ai/docs/api-reference/interviewers/delete-interviewers-id.md)
- [List interviewers](https://intervyo.ai/docs/api-reference/interviewers/get-interviewers.md)
- [Update interviewer](https://intervyo.ai/docs/api-reference/interviewers/patch-interviewers-id.md)
- [Create or fork an interviewer](https://intervyo.ai/docs/api-reference/interviewers/post-interviewers.md): Creates a new interviewer from the body below. To **fork** an existing public profile into your account instead, call this endpoint with `?action=fork` and a body of `{ "sourceId": "<public-profile-uuid>" }`.
- [API Reference](https://intervyo.ai/docs/api-reference/introduction.md): Drive intervyo.ai programmatically — Interviewers, Roles, Rounds, participants, sessions, and code execution over a single REST API.
- [Delete participant](https://intervyo.ai/docs/api-reference/participants/delete-participants-id.md)
- [List participants](https://intervyo.ai/docs/api-reference/participants/get-participants.md)
- [Get participant](https://intervyo.ai/docs/api-reference/participants/get-participants-id.md)
- [List participant sessions](https://intervyo.ai/docs/api-reference/participants/get-participants-id-sessions.md)
- [Update participant](https://intervyo.ai/docs/api-reference/participants/patch-participants-id.md)
- [Create participant](https://intervyo.ai/docs/api-reference/participants/post-participants.md)
- [Bulk import participants](https://intervyo.ai/docs/api-reference/participants/post-participants-bulk.md)
- [JSON-RPC 2.0 endpoint](https://intervyo.ai/docs/api-reference/remote-mcp-server/post-mcp.md)
- [Delete role](https://intervyo.ai/docs/api-reference/roles/delete-roles-id.md)
- [List roles](https://intervyo.ai/docs/api-reference/roles/get-roles.md)
- [Get role](https://intervyo.ai/docs/api-reference/roles/get-roles-id.md)
- [Update role](https://intervyo.ai/docs/api-reference/roles/patch-roles-id.md)
- [Create role](https://intervyo.ai/docs/api-reference/roles/post-roles.md)
- [Delete round](https://intervyo.ai/docs/api-reference/rounds/delete-rounds-id.md)
- [List rounds](https://intervyo.ai/docs/api-reference/rounds/get-rounds.md)
- [Update round](https://intervyo.ai/docs/api-reference/rounds/patch-rounds-id.md)
- [Create round](https://intervyo.ai/docs/api-reference/rounds/post-rounds.md)
- [Cancel session](https://intervyo.ai/docs/api-reference/sessions/delete-sessions-id.md)
- [List sessions](https://intervyo.ai/docs/api-reference/sessions/get-sessions.md)
- [Get session](https://intervyo.ai/docs/api-reference/sessions/get-sessions-id.md)
- [Reschedule session](https://intervyo.ai/docs/api-reference/sessions/patch-sessions-id.md)
- [Schedule session](https://intervyo.ai/docs/api-reference/sessions/post-sessions.md)
- [Resend invite email](https://intervyo.ai/docs/api-reference/sessions/post-sessions-id-resend-invite.md)
- [Authentication](https://intervyo.ai/docs/en/authentication.md): How to authenticate requests against the intervyo.ai REST API with an x-api-key header.
- [Interviewers](https://intervyo.ai/docs/en/concepts/interviewers.md): What an Interviewer is, every field explained simply, and how to make one — with hiring, training, and mock-interview examples.
- [Interviews](https://intervyo.ai/docs/en/concepts/interviews.md): What an AI-led interview is, how the conversation works, and what gets captured.
- [Participants](https://intervyo.ai/docs/en/concepts/participants.md): What a participant is, every field explained simply, and how to add one — with hiring, training, and mock-interview examples.
- [Roles](https://intervyo.ai/docs/en/concepts/roles.md): Blueprints for a role or assessment — rounds, rubrics, AI interviewer, application flow.
- [Rounds](https://intervyo.ai/docs/en/concepts/rounds.md): What a Round is, every field explained simply, and how to build a pipeline — with hiring, training, and mock-interview examples.
- [Rubrics](https://intervyo.ai/docs/en/concepts/rubrics.md): How intervyo.ai scores interviews — dimensions, weights, thresholds, calibration.
- [Sessions](https://intervyo.ai/docs/en/concepts/sessions.md): The session lifecycle, status transitions, and emitted events.
- [Webhooks](https://intervyo.ai/docs/en/concepts/webhooks.md): Real-time event delivery to your endpoint — HMAC-signed, retried, ordered per session.
- [Cookbook: Backend Engineer](https://intervyo.ai/docs/en/cookbook/backend-engineer.md): A standard backend hiring loop — Screen → System Design → Coding — with a rising pass bar and a human sign-off before the final.
- [Cookbook: Frontend Engineer](https://intervyo.ai/docs/en/cookbook/frontend-engineer.md): A frontend hiring loop — Screen → UI & JavaScript → Take-home review — tuned for component design and accessibility.
- [Cookbook: Non-technical Roles](https://intervyo.ai/docs/en/cookbook/non-technical-roles.md): No coding required — set up Customer Support and Sales hiring with a friendly screen and a realistic roleplay, entirely in the dashboard.
- [Cookbook](https://intervyo.ai/docs/en/cookbook/overview.md): Copy-ready recipes for common Roles — ServiceNow, backend, frontend, and non-technical hiring. Each one shows the Role, its Rounds, and the Interviewers to use.
- [Cookbook: ServiceNow Engineer](https://intervyo.ai/docs/en/cookbook/servicenow-engineer.md): Hire ServiceNow engineers when every opening is different — some need ITOM, some HRSD, some both — by reusing module Interviewers across Role variants.
- [ATS integration](https://intervyo.ai/docs/en/guides/ats-integration.md): Push candidates into intervyo.ai and pull scorecards back into your ATS — Greenhouse, Lever, Bullhorn, or custom.
- [Embed the interview widget](https://intervyo.ai/docs/en/guides/embed-widget.md): Let candidates take an intervyo.ai interview without leaving your domain.
- [Hiring, step by step](https://intervyo.ai/docs/en/guides/hiring-step-by-step.md): Build a full hiring interview from scratch — Interviewer, Role, Round, candidate, and the live invite — one small step at a time.
- [How it works, end to end](https://intervyo.ai/docs/en/guides/how-it-works.md): The full journey from signing up to reading a scorecard — every step in order, in plain language.
- [Mock interviews, step by step](https://intervyo.ai/docs/en/guides/mock-interview-step-by-step.md): Give people a realistic practice interview they can repeat as often as they like — perfect for embedding in your own app.
- [Let candidates apply themselves](https://intervyo.ai/docs/en/guides/self-serve-applications.md): Share your template's apply link so people apply on their own — then HR reviews and schedules the interview.
- [Share candidate profiles](https://intervyo.ai/docs/en/guides/sharing-candidate-profiles.md): Send interview results to a hiring manager or client with a no-login link — one candidate at a time, or many side by side.
- [Training, step by step](https://intervyo.ai/docs/en/guides/training-step-by-step.md): Set up a coaching program where people practice and improve — agent, template, retake-friendly stages, and enrolling your team.
- [Introduction](https://intervyo.ai/docs/en/introduction.md): Understand intervyo.ai's core building blocks — Interviewers, Roles, Rounds, and participants — and how they map to hiring, training, and mock interviews.
- [Claude with an API key](https://intervyo.ai/docs/en/mcp/claude-api-key.md): Connect the intervyo MCP server to Claude Code or the Claude Desktop app using an x-api-key header instead of the OAuth connector flow.
- [Claude connectors (web + desktop)](https://intervyo.ai/docs/en/mcp/claude-connectors.md): Add intervyo as a custom OAuth connector in Claude — works on claude.ai in the browser and the Claude Desktop app. No API key to paste.
- [Codex CLI](https://intervyo.ai/docs/en/mcp/codex.md): Connect the intervyo MCP server to OpenAI's Codex CLI with an API key — directly over streamable HTTP, or via the mcp-remote bridge on older versions.
- [Cursor](https://intervyo.ai/docs/en/mcp/cursor.md): Connect the intervyo MCP server to Cursor with an x-api-key header.
- [MCP Server](https://intervyo.ai/docs/en/mcp/overview.md): Connect intervyo.ai to Claude, Codex, Cursor, and other MCP clients — build assessments, add candidates, schedule interviews, and read results in natural language.
- [The Interview-Setup Skill](https://intervyo.ai/docs/en/mcp/skill.md): A Claude Agent Skill that teaches the assistant how to turn a plain-language brief into a structured intervyo.ai assessment — the right questions to ask, the build order, and the field rules that trip people up.
- [Quickstart](https://intervyo.ai/docs/en/quickstart.md): Run your first AI interview in 5 minutes — by UI or by API.

## OpenAPI Specs

- [openapi](https://intervyo.ai/docs/api-reference/openapi.json)