Skip to main content
POST
/
api
/
v1
/
participants
Create participant
curl --request POST \
  --url https://www.intervyo.ai/api/v1/participants \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "email": "<string>",
  "role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "<string>",
  "phone": "<string>",
  "tags": [
    "<string>"
  ],
  "profile": {},
  "background": {},
  "resume_url": "<string>",
  "pipeline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {},
  "status": "<string>"
}
'
import requests

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

payload = {
"name": "<string>",
"email": "<string>",
"role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_id": "<string>",
"phone": "<string>",
"tags": ["<string>"],
"profile": {},
"background": {},
"resume_url": "<string>",
"pipeline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"status": "<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({
name: '<string>',
email: '<string>',
role_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
external_id: '<string>',
phone: '<string>',
tags: ['<string>'],
profile: {},
background: {},
resume_url: '<string>',
pipeline_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
metadata: {},
status: '<string>'
})
};

fetch('https://www.intervyo.ai/api/v1/participants', 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/participants",
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>',
'email' => '<string>',
'role_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'external_id' => '<string>',
'phone' => '<string>',
'tags' => [
'<string>'
],
'profile' => [

],
'background' => [

],
'resume_url' => '<string>',
'pipeline_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'metadata' => [

],
'status' => '<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/participants"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"role_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"external_id\": \"<string>\",\n \"phone\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"profile\": {},\n \"background\": {},\n \"resume_url\": \"<string>\",\n \"pipeline_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {},\n \"status\": \"<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/participants")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"role_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"external_id\": \"<string>\",\n \"phone\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"profile\": {},\n \"background\": {},\n \"resume_url\": \"<string>\",\n \"pipeline_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {},\n \"status\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

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

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 \"email\": \"<string>\",\n \"role_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"external_id\": \"<string>\",\n \"phone\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"profile\": {},\n \"background\": {},\n \"resume_url\": \"<string>\",\n \"pipeline_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {},\n \"status\": \"<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
name
string
required

Full name

email
string
required

Email — unique per account

role_id
string<uuid>

Role to associate

external_id
string

Your ATS / system ID — echoed back in all webhook payloads

phone
string

Phone number

tags
string[]

Arbitrary labels, e.g. ["senior", "remote"]

profile
object

{ title, organization, experienceLevel, location }

background
object

{ skills: string[], education, languages: string[] }

resume_url
string<uri>

Publicly accessible resume URL — triggers vector extraction

pipeline_id
string<uuid>

Assign to a hiring pipeline on creation

metadata
object

Arbitrary key-value store

status
string

Initial status (default: active)

Response

Success

Last modified on July 10, 2026