Skip to main content
POST
/
api
/
v1
/
roles
Create role
curl --request POST \
  --url https://www.intervyo.ai/api/v1/roles \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "template_name": "<string>",
  "description": "<string>",
  "objective": "<string>",
  "domain": "<string>",
  "level": "<string>",
  "requirements": "<string>",
  "skills": [
    "<string>"
  ],
  "soft_skills": [
    "<string>"
  ],
  "additional_notes": "<string>",
  "default_duration_minutes": 123
}
'
import requests

url = "https://www.intervyo.ai/api/v1/roles"

payload = {
"template_name": "<string>",
"description": "<string>",
"objective": "<string>",
"domain": "<string>",
"level": "<string>",
"requirements": "<string>",
"skills": ["<string>"],
"soft_skills": ["<string>"],
"additional_notes": "<string>",
"default_duration_minutes": 123
}
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({
template_name: '<string>',
description: '<string>',
objective: '<string>',
domain: '<string>',
level: '<string>',
requirements: '<string>',
skills: ['<string>'],
soft_skills: ['<string>'],
additional_notes: '<string>',
default_duration_minutes: 123
})
};

fetch('https://www.intervyo.ai/api/v1/roles', 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/roles",
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([
'template_name' => '<string>',
'description' => '<string>',
'objective' => '<string>',
'domain' => '<string>',
'level' => '<string>',
'requirements' => '<string>',
'skills' => [
'<string>'
],
'soft_skills' => [
'<string>'
],
'additional_notes' => '<string>',
'default_duration_minutes' => 123
]),
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/roles"

payload := strings.NewReader("{\n \"template_name\": \"<string>\",\n \"description\": \"<string>\",\n \"objective\": \"<string>\",\n \"domain\": \"<string>\",\n \"level\": \"<string>\",\n \"requirements\": \"<string>\",\n \"skills\": [\n \"<string>\"\n ],\n \"soft_skills\": [\n \"<string>\"\n ],\n \"additional_notes\": \"<string>\",\n \"default_duration_minutes\": 123\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/roles")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"template_name\": \"<string>\",\n \"description\": \"<string>\",\n \"objective\": \"<string>\",\n \"domain\": \"<string>\",\n \"level\": \"<string>\",\n \"requirements\": \"<string>\",\n \"skills\": [\n \"<string>\"\n ],\n \"soft_skills\": [\n \"<string>\"\n ],\n \"additional_notes\": \"<string>\",\n \"default_duration_minutes\": 123\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://www.intervyo.ai/api/v1/roles")

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 \"template_name\": \"<string>\",\n \"description\": \"<string>\",\n \"objective\": \"<string>\",\n \"domain\": \"<string>\",\n \"level\": \"<string>\",\n \"requirements\": \"<string>\",\n \"skills\": [\n \"<string>\"\n ],\n \"soft_skills\": [\n \"<string>\"\n ],\n \"additional_notes\": \"<string>\",\n \"default_duration_minutes\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "error": "<string>",
  "issues": [
    {}
  ]
}
{
"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
template_name
string
required

Display name, e.g. "Senior Backend Engineer"

use_case
enum<string>
required

Determines recommendation vocabulary

Available options:
hiring,
admissions,
training,
custom_api
description
string
required

1–3 sentence overview of the role

objective
string
required

What the interview should determine

success_outcome
enum<string>

Outcome label (auto-derived from use_case if omitted)

Available options:
hire_no_hire,
admit_reject,
pass_fail,
ready_needs_training,
certified_not_certified,
custom
status
enum<string>

Default: active

Available options:
draft,
active,
archived
domain
string

Industry or field, e.g. "Software Engineering"

level
string

Seniority, e.g. "Senior / 5+ years"

requirements
string

What the candidate must demonstrate to pass

skills
string[]

Technical skills to probe, e.g. ["Go", "PostgreSQL"]

soft_skills
string[]

Behavioural traits, e.g. ["Communication", "Ownership"]

additional_notes
string

Context for the AI — company culture, edge cases, etc.

default_duration_minutes
integer

Default session length (default: 30)

default_difficulty
enum<string>

Default: intermediate

Available options:
beginner,
intermediate,
advanced,
expert,
adaptive
default_session_mode
enum<string>

Default: live_ai_interview

Available options:
live_ai_interview,
async_interview,
roleplay_simulation,
practice_session,
manual_review
visibility
enum<string>

Default: team

Available options:
private,
team,
organization,
public_template

Response

Success

Last modified on July 10, 2026