Skip to main content
POST
/
api
/
v1
/
sessions
Schedule session
curl --request POST \
  --url https://www.intervyo.ai/api/v1/sessions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "candidate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "stage": "<string>",
  "interview_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "idempotency_key": "<string>",
  "scheduled_at": "2023-11-07T05:31:56Z",
  "timezone": "<string>",
  "notes": "<string>",
  "force": true,
  "accountSlug": "<string>"
}
'
import requests

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

payload = {
"candidate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stage": "<string>",
"interview_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"idempotency_key": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"timezone": "<string>",
"notes": "<string>",
"force": True,
"accountSlug": "<string>"
}
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({
candidate_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
role_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
stage: '<string>',
interview_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
idempotency_key: '<string>',
scheduled_at: '2023-11-07T05:31:56Z',
timezone: '<string>',
notes: '<string>',
force: true,
accountSlug: '<string>'
})
};

fetch('https://www.intervyo.ai/api/v1/sessions', 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/sessions",
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([
'candidate_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'role_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'stage' => '<string>',
'interview_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'idempotency_key' => '<string>',
'scheduled_at' => '2023-11-07T05:31:56Z',
'timezone' => '<string>',
'notes' => '<string>',
'force' => true,
'accountSlug' => '<string>'
]),
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/sessions"

payload := strings.NewReader("{\n \"candidate_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"role_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"stage\": \"<string>\",\n \"interview_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"idempotency_key\": \"<string>\",\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"timezone\": \"<string>\",\n \"notes\": \"<string>\",\n \"force\": true,\n \"accountSlug\": \"<string>\"\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/sessions")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"candidate_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"role_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"stage\": \"<string>\",\n \"interview_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"idempotency_key\": \"<string>\",\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"timezone\": \"<string>\",\n \"notes\": \"<string>\",\n \"force\": true,\n \"accountSlug\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

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

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 \"candidate_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"role_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"stage\": \"<string>\",\n \"interview_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"idempotency_key\": \"<string>\",\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"timezone\": \"<string>\",\n \"notes\": \"<string>\",\n \"force\": true,\n \"accountSlug\": \"<string>\"\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
candidate_id
string<uuid>
required

Participant to schedule

role_id
string<uuid>
required

Role to use

stage
string
required

Stage label, e.g. "screen", "technical", "final"

interview_id
string<uuid>

Specific round ID โ€” auto-selected if omitted

idempotency_key
string

Unique key per request โ€” returns the existing session if the key was already used

Maximum string length: 255
scheduled_at
string<date-time>

When to schedule the session

timezone
string

IANA timezone, e.g. America/New_York (default: UTC)

notes
string

Internal notes โ€” not shown to the candidate

Maximum string length: 1000
force
boolean

Skip the duplicate-session check (default: false)

accountSlug
string

Team slug โ€” required for session (cookie) auth

Response

Success

Last modified on July 10, 2026