Create Interview
curl --request POST \
--url https://api.ontora.com/v1/interviews \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"goal": "<string>",
"agent_behavior": "<string>",
"channel": "google_meet",
"completion_threshold": 90,
"timeframe_start": "2023-11-07T05:31:56Z",
"timeframe_end": "2023-11-07T05:31:56Z",
"interview_order": "seniority_high_first",
"interview_duration_minutes": 30,
"timezone": "<string>",
"start_immediately": true,
"scheduling_mode": "availability",
"quick_mode_hours": 123,
"weekly_availability": {},
"project_context": "<string>",
"success_criteria": "<string>",
"interview_context_for_employee": "<string>",
"interview_type": "speaking_default",
"welcome_screen": "<string>",
"closing_message": "<string>",
"folder": "<string>",
"recurring_interval": "<string>"
}
'import requests
url = "https://api.ontora.com/v1/interviews"
payload = {
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"goal": "<string>",
"agent_behavior": "<string>",
"channel": "google_meet",
"completion_threshold": 90,
"timeframe_start": "2023-11-07T05:31:56Z",
"timeframe_end": "2023-11-07T05:31:56Z",
"interview_order": "seniority_high_first",
"interview_duration_minutes": 30,
"timezone": "<string>",
"start_immediately": True,
"scheduling_mode": "availability",
"quick_mode_hours": 123,
"weekly_availability": {},
"project_context": "<string>",
"success_criteria": "<string>",
"interview_context_for_employee": "<string>",
"interview_type": "speaking_default",
"welcome_screen": "<string>",
"closing_message": "<string>",
"folder": "<string>",
"recurring_interval": "<string>"
}
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({
workspace_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
project_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
description: '<string>',
goal: '<string>',
agent_behavior: '<string>',
channel: 'google_meet',
completion_threshold: 90,
timeframe_start: '2023-11-07T05:31:56Z',
timeframe_end: '2023-11-07T05:31:56Z',
interview_order: 'seniority_high_first',
interview_duration_minutes: 30,
timezone: '<string>',
start_immediately: true,
scheduling_mode: 'availability',
quick_mode_hours: 123,
weekly_availability: {},
project_context: '<string>',
success_criteria: '<string>',
interview_context_for_employee: '<string>',
interview_type: 'speaking_default',
welcome_screen: '<string>',
closing_message: '<string>',
folder: '<string>',
recurring_interval: '<string>'
})
};
fetch('https://api.ontora.com/v1/interviews', 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.ontora.com/v1/interviews",
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([
'workspace_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'project_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'description' => '<string>',
'goal' => '<string>',
'agent_behavior' => '<string>',
'channel' => 'google_meet',
'completion_threshold' => 90,
'timeframe_start' => '2023-11-07T05:31:56Z',
'timeframe_end' => '2023-11-07T05:31:56Z',
'interview_order' => 'seniority_high_first',
'interview_duration_minutes' => 30,
'timezone' => '<string>',
'start_immediately' => true,
'scheduling_mode' => 'availability',
'quick_mode_hours' => 123,
'weekly_availability' => [
],
'project_context' => '<string>',
'success_criteria' => '<string>',
'interview_context_for_employee' => '<string>',
'interview_type' => 'speaking_default',
'welcome_screen' => '<string>',
'closing_message' => '<string>',
'folder' => '<string>',
'recurring_interval' => '<string>'
]),
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.ontora.com/v1/interviews"
payload := strings.NewReader("{\n \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"goal\": \"<string>\",\n \"agent_behavior\": \"<string>\",\n \"channel\": \"google_meet\",\n \"completion_threshold\": 90,\n \"timeframe_start\": \"2023-11-07T05:31:56Z\",\n \"timeframe_end\": \"2023-11-07T05:31:56Z\",\n \"interview_order\": \"seniority_high_first\",\n \"interview_duration_minutes\": 30,\n \"timezone\": \"<string>\",\n \"start_immediately\": true,\n \"scheduling_mode\": \"availability\",\n \"quick_mode_hours\": 123,\n \"weekly_availability\": {},\n \"project_context\": \"<string>\",\n \"success_criteria\": \"<string>\",\n \"interview_context_for_employee\": \"<string>\",\n \"interview_type\": \"speaking_default\",\n \"welcome_screen\": \"<string>\",\n \"closing_message\": \"<string>\",\n \"folder\": \"<string>\",\n \"recurring_interval\": \"<string>\"\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.ontora.com/v1/interviews")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"goal\": \"<string>\",\n \"agent_behavior\": \"<string>\",\n \"channel\": \"google_meet\",\n \"completion_threshold\": 90,\n \"timeframe_start\": \"2023-11-07T05:31:56Z\",\n \"timeframe_end\": \"2023-11-07T05:31:56Z\",\n \"interview_order\": \"seniority_high_first\",\n \"interview_duration_minutes\": 30,\n \"timezone\": \"<string>\",\n \"start_immediately\": true,\n \"scheduling_mode\": \"availability\",\n \"quick_mode_hours\": 123,\n \"weekly_availability\": {},\n \"project_context\": \"<string>\",\n \"success_criteria\": \"<string>\",\n \"interview_context_for_employee\": \"<string>\",\n \"interview_type\": \"speaking_default\",\n \"welcome_screen\": \"<string>\",\n \"closing_message\": \"<string>\",\n \"folder\": \"<string>\",\n \"recurring_interval\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ontora.com/v1/interviews")
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 \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"goal\": \"<string>\",\n \"agent_behavior\": \"<string>\",\n \"channel\": \"google_meet\",\n \"completion_threshold\": 90,\n \"timeframe_start\": \"2023-11-07T05:31:56Z\",\n \"timeframe_end\": \"2023-11-07T05:31:56Z\",\n \"interview_order\": \"seniority_high_first\",\n \"interview_duration_minutes\": 30,\n \"timezone\": \"<string>\",\n \"start_immediately\": true,\n \"scheduling_mode\": \"availability\",\n \"quick_mode_hours\": 123,\n \"weekly_availability\": {},\n \"project_context\": \"<string>\",\n \"success_criteria\": \"<string>\",\n \"interview_context_for_employee\": \"<string>\",\n \"interview_type\": \"speaking_default\",\n \"welcome_screen\": \"<string>\",\n \"closing_message\": \"<string>\",\n \"folder\": \"<string>\",\n \"recurring_interval\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"goal": "<string>",
"agent_behavior": "<string>",
"status": "<string>",
"channel": "<string>",
"completion_threshold": 123,
"timeframe_start": "2023-11-07T05:31:56Z",
"timeframe_end": "2023-11-07T05:31:56Z",
"interview_order": "<string>",
"interview_duration_minutes": 123,
"created_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"timezone": "<string>",
"start_immediately": true,
"scheduling_mode": "availability",
"quick_mode_hours": 123,
"weekly_availability": {},
"project_context": "<string>",
"success_criteria": "<string>",
"interview_context_for_employee": "<string>",
"interview_type": "<string>",
"welcome_screen": "<string>",
"closing_message": "<string>",
"folder": "<string>",
"recurring_interval": "<string>",
"contact_count": 0,
"completed_count": 0,
"scheduled_count": 0
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}interviews
Create Interview
POST
/
v1
/
interviews
Create Interview
curl --request POST \
--url https://api.ontora.com/v1/interviews \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"goal": "<string>",
"agent_behavior": "<string>",
"channel": "google_meet",
"completion_threshold": 90,
"timeframe_start": "2023-11-07T05:31:56Z",
"timeframe_end": "2023-11-07T05:31:56Z",
"interview_order": "seniority_high_first",
"interview_duration_minutes": 30,
"timezone": "<string>",
"start_immediately": true,
"scheduling_mode": "availability",
"quick_mode_hours": 123,
"weekly_availability": {},
"project_context": "<string>",
"success_criteria": "<string>",
"interview_context_for_employee": "<string>",
"interview_type": "speaking_default",
"welcome_screen": "<string>",
"closing_message": "<string>",
"folder": "<string>",
"recurring_interval": "<string>"
}
'import requests
url = "https://api.ontora.com/v1/interviews"
payload = {
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"goal": "<string>",
"agent_behavior": "<string>",
"channel": "google_meet",
"completion_threshold": 90,
"timeframe_start": "2023-11-07T05:31:56Z",
"timeframe_end": "2023-11-07T05:31:56Z",
"interview_order": "seniority_high_first",
"interview_duration_minutes": 30,
"timezone": "<string>",
"start_immediately": True,
"scheduling_mode": "availability",
"quick_mode_hours": 123,
"weekly_availability": {},
"project_context": "<string>",
"success_criteria": "<string>",
"interview_context_for_employee": "<string>",
"interview_type": "speaking_default",
"welcome_screen": "<string>",
"closing_message": "<string>",
"folder": "<string>",
"recurring_interval": "<string>"
}
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({
workspace_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
project_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
description: '<string>',
goal: '<string>',
agent_behavior: '<string>',
channel: 'google_meet',
completion_threshold: 90,
timeframe_start: '2023-11-07T05:31:56Z',
timeframe_end: '2023-11-07T05:31:56Z',
interview_order: 'seniority_high_first',
interview_duration_minutes: 30,
timezone: '<string>',
start_immediately: true,
scheduling_mode: 'availability',
quick_mode_hours: 123,
weekly_availability: {},
project_context: '<string>',
success_criteria: '<string>',
interview_context_for_employee: '<string>',
interview_type: 'speaking_default',
welcome_screen: '<string>',
closing_message: '<string>',
folder: '<string>',
recurring_interval: '<string>'
})
};
fetch('https://api.ontora.com/v1/interviews', 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.ontora.com/v1/interviews",
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([
'workspace_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'project_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'description' => '<string>',
'goal' => '<string>',
'agent_behavior' => '<string>',
'channel' => 'google_meet',
'completion_threshold' => 90,
'timeframe_start' => '2023-11-07T05:31:56Z',
'timeframe_end' => '2023-11-07T05:31:56Z',
'interview_order' => 'seniority_high_first',
'interview_duration_minutes' => 30,
'timezone' => '<string>',
'start_immediately' => true,
'scheduling_mode' => 'availability',
'quick_mode_hours' => 123,
'weekly_availability' => [
],
'project_context' => '<string>',
'success_criteria' => '<string>',
'interview_context_for_employee' => '<string>',
'interview_type' => 'speaking_default',
'welcome_screen' => '<string>',
'closing_message' => '<string>',
'folder' => '<string>',
'recurring_interval' => '<string>'
]),
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.ontora.com/v1/interviews"
payload := strings.NewReader("{\n \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"goal\": \"<string>\",\n \"agent_behavior\": \"<string>\",\n \"channel\": \"google_meet\",\n \"completion_threshold\": 90,\n \"timeframe_start\": \"2023-11-07T05:31:56Z\",\n \"timeframe_end\": \"2023-11-07T05:31:56Z\",\n \"interview_order\": \"seniority_high_first\",\n \"interview_duration_minutes\": 30,\n \"timezone\": \"<string>\",\n \"start_immediately\": true,\n \"scheduling_mode\": \"availability\",\n \"quick_mode_hours\": 123,\n \"weekly_availability\": {},\n \"project_context\": \"<string>\",\n \"success_criteria\": \"<string>\",\n \"interview_context_for_employee\": \"<string>\",\n \"interview_type\": \"speaking_default\",\n \"welcome_screen\": \"<string>\",\n \"closing_message\": \"<string>\",\n \"folder\": \"<string>\",\n \"recurring_interval\": \"<string>\"\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.ontora.com/v1/interviews")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"goal\": \"<string>\",\n \"agent_behavior\": \"<string>\",\n \"channel\": \"google_meet\",\n \"completion_threshold\": 90,\n \"timeframe_start\": \"2023-11-07T05:31:56Z\",\n \"timeframe_end\": \"2023-11-07T05:31:56Z\",\n \"interview_order\": \"seniority_high_first\",\n \"interview_duration_minutes\": 30,\n \"timezone\": \"<string>\",\n \"start_immediately\": true,\n \"scheduling_mode\": \"availability\",\n \"quick_mode_hours\": 123,\n \"weekly_availability\": {},\n \"project_context\": \"<string>\",\n \"success_criteria\": \"<string>\",\n \"interview_context_for_employee\": \"<string>\",\n \"interview_type\": \"speaking_default\",\n \"welcome_screen\": \"<string>\",\n \"closing_message\": \"<string>\",\n \"folder\": \"<string>\",\n \"recurring_interval\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ontora.com/v1/interviews")
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 \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\",\n \"goal\": \"<string>\",\n \"agent_behavior\": \"<string>\",\n \"channel\": \"google_meet\",\n \"completion_threshold\": 90,\n \"timeframe_start\": \"2023-11-07T05:31:56Z\",\n \"timeframe_end\": \"2023-11-07T05:31:56Z\",\n \"interview_order\": \"seniority_high_first\",\n \"interview_duration_minutes\": 30,\n \"timezone\": \"<string>\",\n \"start_immediately\": true,\n \"scheduling_mode\": \"availability\",\n \"quick_mode_hours\": 123,\n \"weekly_availability\": {},\n \"project_context\": \"<string>\",\n \"success_criteria\": \"<string>\",\n \"interview_context_for_employee\": \"<string>\",\n \"interview_type\": \"speaking_default\",\n \"welcome_screen\": \"<string>\",\n \"closing_message\": \"<string>\",\n \"folder\": \"<string>\",\n \"recurring_interval\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"goal": "<string>",
"agent_behavior": "<string>",
"status": "<string>",
"channel": "<string>",
"completion_threshold": 123,
"timeframe_start": "2023-11-07T05:31:56Z",
"timeframe_end": "2023-11-07T05:31:56Z",
"interview_order": "<string>",
"interview_duration_minutes": 123,
"created_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"timezone": "<string>",
"start_immediately": true,
"scheduling_mode": "availability",
"quick_mode_hours": 123,
"weekly_availability": {},
"project_context": "<string>",
"success_criteria": "<string>",
"interview_context_for_employee": "<string>",
"interview_type": "<string>",
"welcome_screen": "<string>",
"closing_message": "<string>",
"folder": "<string>",
"recurring_interval": "<string>",
"contact_count": 0,
"completed_count": 0,
"scheduled_count": 0
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Body
application/json
Response
Successful Response
Was this page helpful?
⌘I