Create the interview config

curl --request POST \
  --url https://api.talentunveiled.com/api/v2/jobs/{job_id}/interview-config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "max_retakes": 1073741823,
  "require_camera": true,
  "prompt_intro": "<string>",
  "prompt_outro": "<string>",
  "prompt_additional_instructions": "<string>",
  "organization_name_override": "<string>",
  "schedule_meeting": true,
  "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.talentunveiled.com/api/v2/jobs/{job_id}/interview-config"

payload = {
    "max_retakes": 1073741823,
    "require_camera": True,
    "prompt_intro": "<string>",
    "prompt_outro": "<string>",
    "prompt_additional_instructions": "<string>",
    "organization_name_override": "<string>",
    "schedule_meeting": True,
    "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    max_retakes: 1073741823,
    require_camera: true,
    prompt_intro: '<string>',
    prompt_outro: '<string>',
    prompt_additional_instructions: '<string>',
    organization_name_override: '<string>',
    schedule_meeting: true,
    template_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.talentunveiled.com/api/v2/jobs/{job_id}/interview-config', 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://api.talentunveiled.com/api/v2/jobs/{job_id}/interview-config",
  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([
    'max_retakes' => 1073741823,
    'require_camera' => true,
    'prompt_intro' => '<string>',
    'prompt_outro' => '<string>',
    'prompt_additional_instructions' => '<string>',
    'organization_name_override' => '<string>',
    'schedule_meeting' => true,
    'template_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.talentunveiled.com/api/v2/jobs/{job_id}/interview-config"

	payload := strings.NewReader("{\n  \"max_retakes\": 1073741823,\n  \"require_camera\": true,\n  \"prompt_intro\": \"<string>\",\n  \"prompt_outro\": \"<string>\",\n  \"prompt_additional_instructions\": \"<string>\",\n  \"organization_name_override\": \"<string>\",\n  \"schedule_meeting\": true,\n  \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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://api.talentunveiled.com/api/v2/jobs/{job_id}/interview-config")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"max_retakes\": 1073741823,\n  \"require_camera\": true,\n  \"prompt_intro\": \"<string>\",\n  \"prompt_outro\": \"<string>\",\n  \"prompt_additional_instructions\": \"<string>\",\n  \"organization_name_override\": \"<string>\",\n  \"schedule_meeting\": true,\n  \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.talentunveiled.com/api/v2/jobs/{job_id}/interview-config")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"max_retakes\": 1073741823,\n  \"require_camera\": true,\n  \"prompt_intro\": \"<string>\",\n  \"prompt_outro\": \"<string>\",\n  \"prompt_additional_instructions\": \"<string>\",\n  \"organization_name_override\": \"<string>\",\n  \"schedule_meeting\": true,\n  \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "mode": "web",
  "mode_locked": true,
  "max_retakes": 123,
  "require_camera": true,
  "prompt_intro": "<string>",
  "prompt_outro": "<string>",
  "prompt_additional_instructions": "<string>",
  "organization_name_override": "<string>",
  "resolved_interviewer_name": "<string>",
  "resolved_organization_name": "<string>",
  "resolved_prompt_intro": "<string>",
  "estimated_duration_minutes": 123,
  "schedule": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "enabled": true,
    "scheduling_horizon_days": 1073741823,
    "available_weekdays": [
      "monday"
    ],
    "start_time": "<string>",
    "end_time": "<string>",
    "minimum_notice_hours": 1073741823
  },
  "criteria_count": 123,
  "question_count": 123,
  "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "template_source": "none",
  "template_name_snapshot": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

[
  {
    "code": "error",
    "detail": "<string>",
    "attr": "<string>"
  }
]

[
  {
    "code": "error",
    "detail": "<string>",
    "attr": "<string>"
  }
]

[
  {
    "code": "error",
    "detail": "<string>",
    "attr": "<string>"
  }
]

[
  {
    "code": "error",
    "detail": "<string>",
    "attr": "<string>"
  }
]

POST

jobs

{job_id}

interview-config

Create the interview config

curl --request POST \
  --url https://api.talentunveiled.com/api/v2/jobs/{job_id}/interview-config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "max_retakes": 1073741823,
  "require_camera": true,
  "prompt_intro": "<string>",
  "prompt_outro": "<string>",
  "prompt_additional_instructions": "<string>",
  "organization_name_override": "<string>",
  "schedule_meeting": true,
  "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.talentunveiled.com/api/v2/jobs/{job_id}/interview-config"

payload = {
    "max_retakes": 1073741823,
    "require_camera": True,
    "prompt_intro": "<string>",
    "prompt_outro": "<string>",
    "prompt_additional_instructions": "<string>",
    "organization_name_override": "<string>",
    "schedule_meeting": True,
    "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    max_retakes: 1073741823,
    require_camera: true,
    prompt_intro: '<string>',
    prompt_outro: '<string>',
    prompt_additional_instructions: '<string>',
    organization_name_override: '<string>',
    schedule_meeting: true,
    template_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.talentunveiled.com/api/v2/jobs/{job_id}/interview-config', 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://api.talentunveiled.com/api/v2/jobs/{job_id}/interview-config",
  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([
    'max_retakes' => 1073741823,
    'require_camera' => true,
    'prompt_intro' => '<string>',
    'prompt_outro' => '<string>',
    'prompt_additional_instructions' => '<string>',
    'organization_name_override' => '<string>',
    'schedule_meeting' => true,
    'template_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.talentunveiled.com/api/v2/jobs/{job_id}/interview-config"

	payload := strings.NewReader("{\n  \"max_retakes\": 1073741823,\n  \"require_camera\": true,\n  \"prompt_intro\": \"<string>\",\n  \"prompt_outro\": \"<string>\",\n  \"prompt_additional_instructions\": \"<string>\",\n  \"organization_name_override\": \"<string>\",\n  \"schedule_meeting\": true,\n  \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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://api.talentunveiled.com/api/v2/jobs/{job_id}/interview-config")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"max_retakes\": 1073741823,\n  \"require_camera\": true,\n  \"prompt_intro\": \"<string>\",\n  \"prompt_outro\": \"<string>\",\n  \"prompt_additional_instructions\": \"<string>\",\n  \"organization_name_override\": \"<string>\",\n  \"schedule_meeting\": true,\n  \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.talentunveiled.com/api/v2/jobs/{job_id}/interview-config")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"max_retakes\": 1073741823,\n  \"require_camera\": true,\n  \"prompt_intro\": \"<string>\",\n  \"prompt_outro\": \"<string>\",\n  \"prompt_additional_instructions\": \"<string>\",\n  \"organization_name_override\": \"<string>\",\n  \"schedule_meeting\": true,\n  \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "mode": "web",
  "mode_locked": true,
  "max_retakes": 123,
  "require_camera": true,
  "prompt_intro": "<string>",
  "prompt_outro": "<string>",
  "prompt_additional_instructions": "<string>",
  "organization_name_override": "<string>",
  "resolved_interviewer_name": "<string>",
  "resolved_organization_name": "<string>",
  "resolved_prompt_intro": "<string>",
  "estimated_duration_minutes": 123,
  "schedule": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "enabled": true,
    "scheduling_horizon_days": 1073741823,
    "available_weekdays": [
      "monday"
    ],
    "start_time": "<string>",
    "end_time": "<string>",
    "minimum_notice_hours": 1073741823
  },
  "criteria_count": 123,
  "question_count": 123,
  "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "template_source": "none",
  "template_name_snapshot": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

[
  {
    "code": "error",
    "detail": "<string>",
    "attr": "<string>"
  }
]

[
  {
    "code": "error",
    "detail": "<string>",
    "attr": "<string>"
  }
]

[
  {
    "code": "error",
    "detail": "<string>",
    "attr": "<string>"
  }
]

[
  {
    "code": "error",
    "detail": "<string>",
    "attr": "<string>"
  }
]

Authorizations

Authorization

string

header

required

API key authentication for the public API. Pass your API key as a Bearer token.

Path Parameters

job_id

string<uuid>

required

Body

application/json

Write shape for POST/PATCH /jobs/{job_id}/interview-config.

The field list is PINNED rather than inherited: the company serializer is free to grow, and every field it gains must be a deliberate public-API decision instead of appearing here on its own. DRF silently drops a field missing from this list rather than complaining, so the pin is enforced by test_write_serializer_field_set_is_pinned.

mode

enum<string>

Interview mode: web call, or phone call to the applicant. Cannot change once the job has interview sessions (409); the organization default config stays changeable. Omitted on create: defaults to the applied template's mode, else the organization default.

web - Web
phone - Phone

Available options:

web,

phone

max_retakes

integer

Maximum number of retakes allowed for the interview. 0 means no retakes allowed. In web mode candidates can start a retake themselves from the candidate portal; in phone mode a retake can only be triggered via the retake API endpoints and places a new outbound call.

Required range: 0 <= x <= 2147483647

require_camera

boolean

[Web only] Whether the candidate is required to have a camera for the interview.

prompt_intro

string

Script for the voice assistant to say at the beginning of the interview.

prompt_outro

string

Script for the voice assistant to say at the end of the interview.

prompt_additional_instructions

string

Additional instructions given to the voice assistant that guide its behavior during the interview.

organization_name_override

string

Override name of the organization used by the voice assistant. If not set, the organization name is used.

Maximum string length: 100

schedule_meeting

boolean

When enabled, candidates schedule a meeting with a human interviewer within the AI interview.

template_id

string<uuid> | null

write-only

Template to apply: copies its config values and generation prompts onto the config (later template edits never affect it); null detaches and resets the managed fields (on create, null simply means no template). Cannot be combined with mode (400), except null on create. Never starts generation - use the auto-setup endpoint.

Response

Read shape for GET /jobs/{job_id}/interview-config.

Adds the read-only resolved_* org-default fallback fields plus criteria_count/question_count/schedule that the company config serializer does not expose. job_id mirrors the job from the URL/FK.

The resolved_ prefix marks the effective value after org-default fallback, distinguishing it from the raw writable field it shadows (resolved_prompt_intro vs prompt_intro); dropping the prefix would collide with those fields.

string<uuid>

required

read-only

job_id

string<uuid>

required

read-only

mode

enum<string>

required

Mode of the interview. WEB: The interview will be conducted through a web interface where applicants have a web call. PHONE: TalentUnveiled will call the applicant's phone number and conduct the interview over the phone. Can no longer be changed once the job has interview sessions (a 409 is returned); the organization default config stays changeable.

web - Web
phone - Phone

Available options:

web,

phone

mode_locked

boolean

required

read-only

Whether the interview mode is locked. True once the job has interview sessions; changing mode then returns a 409.

max_retakes

integer

required

read-only

require_camera

boolean

required

read-only

[Web only] Whether the candidate is required to have a camera for the interview.

prompt_intro

string

required

read-only

Script for the voice assistant to say at the beginning of the interview.

prompt_outro

string

required

read-only

Script for the voice assistant to say at the end of the interview.

prompt_additional_instructions

string

required

read-only

Additional instructions given to the voice assistant that guide its behavior during the interview.

organization_name_override

string

required

read-only

Override name of the organization used by the voice assistant. If not set, the organization name is used.

resolved_interviewer_name

string

required

read-only

Interviewer name after org-default fallback.

resolved_organization_name

string

required

read-only

Organization display name after override/org-default fallback.

resolved_prompt_intro

string

required

read-only

Interview intro prompt after org-default fallback.

estimated_duration_minutes

integer

required

read-only

schedule

object

required

Show child attributes

criteria_count

integer

required

read-only

question_count

integer

required

read-only

template_id

string<uuid> | null

required

read-only

Interview template this config was set up from; null when none is applied.

template_source

enum<string>

required

How the template was assigned: manually picked by a recruiter, auto-selected by AI for an automatically created job, or none.

none - None
manual - Manual
auto - Auto

Available options:

none,

manual,

auto

template_name_snapshot

string

required

read-only

Name of the applied template at apply time. Survives template rename and deletion. Populated only while a template is applied; empty otherwise.

created_at

string<date-time>

required

read-only

API v2 Reference

Meta

Organization Configuration

Members

Jobs

Hiring Team

Interview Configuration

Interview Criteria

Interview Questions

Applications

Interview Results

Interview Calls

CV Evaluations

Insights

Webhooks

Create the interview config

Authorizations

Path Parameters

Body

Response