Skip to main content
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>",
  "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>",
"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>',
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>',
'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 \"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 \"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 \"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

x-api-key
string
header
required

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

Body

application/json
role_id
string<uuid>
required

Parent Role

type
string
required

Stage type label, e.g. "technical"

stage_name
string

Display name shown to candidates

stage_type
enum<string>

Interview format — determines session_mode

Available options:
ai_interview,
roleplay_simulation,
practice_session,
manual_review,
async_assessment,
final_review
stage_order
integer

Position in pipeline (default: 0)

duration_minutes
integer

Session length in minutes (default: 30)

interviewer_id
string<uuid>

AI persona to use for this stage

difficulty
enum<string>

Default: intermediate

Available options:
beginner,
intermediate,
advanced,
expert,
adaptive
pass_threshold
number

Minimum score to pass

allow_retake
boolean

Allow retries on failure (default: false)

automation_rule
enum<string>

What happens automatically on completion (default: none)

Available options:
none,
auto_advance,
require_reviewer_approval
status
enum<string>

Default: active

Available options:
draft,
active,
archived

Response

Success

Last modified on July 10, 2026