Skip to main content
POST
/
api
/
v1
/
interviewers
Create or fork an interviewer
curl --request POST \
  --url https://www.intervyo.ai/api/v1/interviewers \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "persona": "<string>",
  "evaluationDimensions": [
    {}
  ],
  "context": {},
  "interaction": {},
  "scoring": {},
  "output": {},
  "additionalInstructions": "<string>",
  "isPublic": true
}
'
import requests

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

payload = {
"name": "<string>",
"persona": "<string>",
"evaluationDimensions": [{}],
"context": {},
"interaction": {},
"scoring": {},
"output": {},
"additionalInstructions": "<string>",
"isPublic": 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({
name: '<string>',
persona: '<string>',
evaluationDimensions: [{}],
context: {},
interaction: {},
scoring: {},
output: {},
additionalInstructions: '<string>',
isPublic: true
})
};

fetch('https://www.intervyo.ai/api/v1/interviewers', 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/interviewers",
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([
'name' => '<string>',
'persona' => '<string>',
'evaluationDimensions' => [
[

]
],
'context' => [

],
'interaction' => [

],
'scoring' => [

],
'output' => [

],
'additionalInstructions' => '<string>',
'isPublic' => 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/interviewers"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"persona\": \"<string>\",\n \"evaluationDimensions\": [\n {}\n ],\n \"context\": {},\n \"interaction\": {},\n \"scoring\": {},\n \"output\": {},\n \"additionalInstructions\": \"<string>\",\n \"isPublic\": 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/interviewers")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"persona\": \"<string>\",\n \"evaluationDimensions\": [\n {}\n ],\n \"context\": {},\n \"interaction\": {},\n \"scoring\": {},\n \"output\": {},\n \"additionalInstructions\": \"<string>\",\n \"isPublic\": true\n}")
.asString();
require 'uri'
require 'net/http'

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

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 \"name\": \"<string>\",\n \"persona\": \"<string>\",\n \"evaluationDimensions\": [\n {}\n ],\n \"context\": {},\n \"interaction\": {},\n \"scoring\": {},\n \"output\": {},\n \"additionalInstructions\": \"<string>\",\n \"isPublic\": 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.

Query Parameters

action
string

Set to "fork" to fork a public profile instead of creating a new one

Body

application/json
name
string
required

Display name, e.g. "Senior Engineering Interviewer"

persona
string
required

How the AI introduces itself at the start of a session

useCase
enum<string>
required

Determines recommendation vocabulary

Available options:
hiring,
admissions,
training,
custom_api
evaluationDimensions
object[]
required

[{ name, description, weight }] — weights must sum to 100

context
object

{ organizationContext?, domainContext?, scenarioContext? }

interaction
object

{ tone?: friendly|professional|strict|challenging, style?: structured|conversational|adaptive, difficulty?: easy|medium|hard|adaptive, probingDepth?: low|medium|high }

scoring
object

{ scale?: 0-10|0-5|0-100, scoringMethod?: weighted_average|rule_based, recommendationLogic? }

output
object

{ includeTranscript?, includeScoreBreakdown?, includeRecommendation?, includeImprovementFeedback? } — all default to true

additionalInstructions
string

Edge cases, constraints, or tone overrides for this agent

isPublic
boolean

Publish to the shared library (default: false)

Response

Success

Last modified on June 9, 2026