Create round
curl --request POST \
--url https://www.intervyo.ai/api/v1/rounds \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"interviewer": {
"name": "<string>",
"persona": "<string>",
"evaluationDimensions": [
{
"name": "<string>",
"description": "<string>",
"weight": 50
}
],
"additionalInstructions": "<string>",
"context": {
"organizationContext": "<string>",
"domainContext": "<string>"
},
"interaction": {},
"aiAvatarId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scoring": {},
"output": {
"includeTranscript": true,
"includeScoreBreakdown": true,
"includeRecommendation": true,
"includeImprovementFeedback": true
}
},
"stage_name": "<string>",
"stage_order": 123,
"duration_minutes": 123,
"interviewer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pass_threshold": 123,
"allow_retake": true
}
'import requests
url = "https://www.intervyo.ai/api/v1/rounds"
payload = {
"role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"interviewer": {
"name": "<string>",
"persona": "<string>",
"evaluationDimensions": [
{
"name": "<string>",
"description": "<string>",
"weight": 50
}
],
"additionalInstructions": "<string>",
"context": {
"organizationContext": "<string>",
"domainContext": "<string>"
},
"interaction": {},
"aiAvatarId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scoring": {},
"output": {
"includeTranscript": True,
"includeScoreBreakdown": True,
"includeRecommendation": True,
"includeImprovementFeedback": True
}
},
"stage_name": "<string>",
"stage_order": 123,
"duration_minutes": 123,
"interviewer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pass_threshold": 123,
"allow_retake": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
role_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
type: '<string>',
interviewer: {
name: '<string>',
persona: '<string>',
evaluationDimensions: [{name: '<string>', description: '<string>', weight: 50}],
additionalInstructions: '<string>',
context: {organizationContext: '<string>', domainContext: '<string>'},
interaction: {},
aiAvatarId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
scoring: {},
output: {
includeTranscript: true,
includeScoreBreakdown: true,
includeRecommendation: true,
includeImprovementFeedback: true
}
},
stage_name: '<string>',
stage_order: 123,
duration_minutes: 123,
interviewer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
pass_threshold: 123,
allow_retake: true
})
};
fetch('https://www.intervyo.ai/api/v1/rounds', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.intervyo.ai/api/v1/rounds",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'role_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'type' => '<string>',
'interviewer' => [
'name' => '<string>',
'persona' => '<string>',
'evaluationDimensions' => [
[
'name' => '<string>',
'description' => '<string>',
'weight' => 50
]
],
'additionalInstructions' => '<string>',
'context' => [
'organizationContext' => '<string>',
'domainContext' => '<string>'
],
'interaction' => [
],
'aiAvatarId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'scoring' => [
],
'output' => [
'includeTranscript' => true,
'includeScoreBreakdown' => true,
'includeRecommendation' => true,
'includeImprovementFeedback' => true
]
],
'stage_name' => '<string>',
'stage_order' => 123,
'duration_minutes' => 123,
'interviewer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'pass_threshold' => 123,
'allow_retake' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://www.intervyo.ai/api/v1/rounds"
payload := strings.NewReader("{\n \"role_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"<string>\",\n \"interviewer\": {\n \"name\": \"<string>\",\n \"persona\": \"<string>\",\n \"evaluationDimensions\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"weight\": 50\n }\n ],\n \"additionalInstructions\": \"<string>\",\n \"context\": {\n \"organizationContext\": \"<string>\",\n \"domainContext\": \"<string>\"\n },\n \"interaction\": {},\n \"aiAvatarId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scoring\": {},\n \"output\": {\n \"includeTranscript\": true,\n \"includeScoreBreakdown\": true,\n \"includeRecommendation\": true,\n \"includeImprovementFeedback\": true\n }\n },\n \"stage_name\": \"<string>\",\n \"stage_order\": 123,\n \"duration_minutes\": 123,\n \"interviewer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pass_threshold\": 123,\n \"allow_retake\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://www.intervyo.ai/api/v1/rounds")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"role_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"<string>\",\n \"interviewer\": {\n \"name\": \"<string>\",\n \"persona\": \"<string>\",\n \"evaluationDimensions\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"weight\": 50\n }\n ],\n \"additionalInstructions\": \"<string>\",\n \"context\": {\n \"organizationContext\": \"<string>\",\n \"domainContext\": \"<string>\"\n },\n \"interaction\": {},\n \"aiAvatarId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scoring\": {},\n \"output\": {\n \"includeTranscript\": true,\n \"includeScoreBreakdown\": true,\n \"includeRecommendation\": true,\n \"includeImprovementFeedback\": true\n }\n },\n \"stage_name\": \"<string>\",\n \"stage_order\": 123,\n \"duration_minutes\": 123,\n \"interviewer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pass_threshold\": 123,\n \"allow_retake\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.intervyo.ai/api/v1/rounds")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"role_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"<string>\",\n \"interviewer\": {\n \"name\": \"<string>\",\n \"persona\": \"<string>\",\n \"evaluationDimensions\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"weight\": 50\n }\n ],\n \"additionalInstructions\": \"<string>\",\n \"context\": {\n \"organizationContext\": \"<string>\",\n \"domainContext\": \"<string>\"\n },\n \"interaction\": {},\n \"aiAvatarId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scoring\": {},\n \"output\": {\n \"includeTranscript\": true,\n \"includeScoreBreakdown\": true,\n \"includeRecommendation\": true,\n \"includeImprovementFeedback\": true\n }\n },\n \"stage_name\": \"<string>\",\n \"stage_order\": 123,\n \"duration_minutes\": 123,\n \"interviewer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pass_threshold\": 123,\n \"allow_retake\": true\n}"
response = http.request(request)
puts response.read_body{
"error": "<string>",
"issues": [
{}
]
}{
"error": "<string>",
"issues": [
{}
]
}{
"error": "<string>",
"issues": [
{}
]
}{
"error": "<string>",
"issues": [
{}
]
}Rounds
Create round
POST
/
api
/
v1
/
rounds
Create round
curl --request POST \
--url https://www.intervyo.ai/api/v1/rounds \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"interviewer": {
"name": "<string>",
"persona": "<string>",
"evaluationDimensions": [
{
"name": "<string>",
"description": "<string>",
"weight": 50
}
],
"additionalInstructions": "<string>",
"context": {
"organizationContext": "<string>",
"domainContext": "<string>"
},
"interaction": {},
"aiAvatarId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scoring": {},
"output": {
"includeTranscript": true,
"includeScoreBreakdown": true,
"includeRecommendation": true,
"includeImprovementFeedback": true
}
},
"stage_name": "<string>",
"stage_order": 123,
"duration_minutes": 123,
"interviewer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pass_threshold": 123,
"allow_retake": true
}
'import requests
url = "https://www.intervyo.ai/api/v1/rounds"
payload = {
"role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"interviewer": {
"name": "<string>",
"persona": "<string>",
"evaluationDimensions": [
{
"name": "<string>",
"description": "<string>",
"weight": 50
}
],
"additionalInstructions": "<string>",
"context": {
"organizationContext": "<string>",
"domainContext": "<string>"
},
"interaction": {},
"aiAvatarId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scoring": {},
"output": {
"includeTranscript": True,
"includeScoreBreakdown": True,
"includeRecommendation": True,
"includeImprovementFeedback": True
}
},
"stage_name": "<string>",
"stage_order": 123,
"duration_minutes": 123,
"interviewer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pass_threshold": 123,
"allow_retake": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
role_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
type: '<string>',
interviewer: {
name: '<string>',
persona: '<string>',
evaluationDimensions: [{name: '<string>', description: '<string>', weight: 50}],
additionalInstructions: '<string>',
context: {organizationContext: '<string>', domainContext: '<string>'},
interaction: {},
aiAvatarId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
scoring: {},
output: {
includeTranscript: true,
includeScoreBreakdown: true,
includeRecommendation: true,
includeImprovementFeedback: true
}
},
stage_name: '<string>',
stage_order: 123,
duration_minutes: 123,
interviewer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
pass_threshold: 123,
allow_retake: true
})
};
fetch('https://www.intervyo.ai/api/v1/rounds', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.intervyo.ai/api/v1/rounds",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'role_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'type' => '<string>',
'interviewer' => [
'name' => '<string>',
'persona' => '<string>',
'evaluationDimensions' => [
[
'name' => '<string>',
'description' => '<string>',
'weight' => 50
]
],
'additionalInstructions' => '<string>',
'context' => [
'organizationContext' => '<string>',
'domainContext' => '<string>'
],
'interaction' => [
],
'aiAvatarId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'scoring' => [
],
'output' => [
'includeTranscript' => true,
'includeScoreBreakdown' => true,
'includeRecommendation' => true,
'includeImprovementFeedback' => true
]
],
'stage_name' => '<string>',
'stage_order' => 123,
'duration_minutes' => 123,
'interviewer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'pass_threshold' => 123,
'allow_retake' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://www.intervyo.ai/api/v1/rounds"
payload := strings.NewReader("{\n \"role_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"<string>\",\n \"interviewer\": {\n \"name\": \"<string>\",\n \"persona\": \"<string>\",\n \"evaluationDimensions\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"weight\": 50\n }\n ],\n \"additionalInstructions\": \"<string>\",\n \"context\": {\n \"organizationContext\": \"<string>\",\n \"domainContext\": \"<string>\"\n },\n \"interaction\": {},\n \"aiAvatarId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scoring\": {},\n \"output\": {\n \"includeTranscript\": true,\n \"includeScoreBreakdown\": true,\n \"includeRecommendation\": true,\n \"includeImprovementFeedback\": true\n }\n },\n \"stage_name\": \"<string>\",\n \"stage_order\": 123,\n \"duration_minutes\": 123,\n \"interviewer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pass_threshold\": 123,\n \"allow_retake\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://www.intervyo.ai/api/v1/rounds")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"role_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"<string>\",\n \"interviewer\": {\n \"name\": \"<string>\",\n \"persona\": \"<string>\",\n \"evaluationDimensions\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"weight\": 50\n }\n ],\n \"additionalInstructions\": \"<string>\",\n \"context\": {\n \"organizationContext\": \"<string>\",\n \"domainContext\": \"<string>\"\n },\n \"interaction\": {},\n \"aiAvatarId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scoring\": {},\n \"output\": {\n \"includeTranscript\": true,\n \"includeScoreBreakdown\": true,\n \"includeRecommendation\": true,\n \"includeImprovementFeedback\": true\n }\n },\n \"stage_name\": \"<string>\",\n \"stage_order\": 123,\n \"duration_minutes\": 123,\n \"interviewer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pass_threshold\": 123,\n \"allow_retake\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.intervyo.ai/api/v1/rounds")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"role_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"<string>\",\n \"interviewer\": {\n \"name\": \"<string>\",\n \"persona\": \"<string>\",\n \"evaluationDimensions\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"weight\": 50\n }\n ],\n \"additionalInstructions\": \"<string>\",\n \"context\": {\n \"organizationContext\": \"<string>\",\n \"domainContext\": \"<string>\"\n },\n \"interaction\": {},\n \"aiAvatarId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scoring\": {},\n \"output\": {\n \"includeTranscript\": true,\n \"includeScoreBreakdown\": true,\n \"includeRecommendation\": true,\n \"includeImprovementFeedback\": true\n }\n },\n \"stage_name\": \"<string>\",\n \"stage_order\": 123,\n \"duration_minutes\": 123,\n \"interviewer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pass_threshold\": 123,\n \"allow_retake\": true\n}"
response = http.request(request)
puts response.read_body{
"error": "<string>",
"issues": [
{}
]
}{
"error": "<string>",
"issues": [
{}
]
}{
"error": "<string>",
"issues": [
{}
]
}{
"error": "<string>",
"issues": [
{}
]
}Authorizations
API key with the iv_live_ prefix. Create one under Developer → API Keys.
Body
application/json
Parent Role
Stage type label, e.g. "technical"
The AI interviewer for this round, created inline and linked atomically. Provide this OR interviewer_id.
Show child attributes
Show child attributes
Display name shown to candidates
Interview format — determines session_mode
Available options:
ai_interview, roleplay_simulation, practice_session, manual_review, async_assessment, final_review Position in pipeline (default: 0)
Session length in minutes (default: 30)
Link an EXISTING interviewer instead of creating one. Provide this OR the nested interviewer object.
Default: intermediate
Available options:
beginner, intermediate, advanced, expert, adaptive Minimum score to pass
Allow retries on failure (default: false)
What happens automatically on completion (default: none)
Available options:
none, auto_advance, require_reviewer_approval Default: active
Available options:
draft, active, archived Response
Success
Last modified on July 26, 2026
Was this page helpful?