Add Question To Set
curl --request POST \
--url https://api.ontora.com/v1/interviews/{interview_id}/question-sets/{set_id}/questions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"question_text": "<string>",
"is_required": true,
"sort_order": 0,
"question_type": "open_ended",
"options": [
"<string>"
],
"component_config": {},
"follow_up_rule": "auto",
"follow_up_guideline": "",
"requires_screen_share": false,
"screen_share_prompt": ""
}
'import requests
url = "https://api.ontora.com/v1/interviews/{interview_id}/question-sets/{set_id}/questions"
payload = {
"question_text": "<string>",
"is_required": True,
"sort_order": 0,
"question_type": "open_ended",
"options": ["<string>"],
"component_config": {},
"follow_up_rule": "auto",
"follow_up_guideline": "",
"requires_screen_share": False,
"screen_share_prompt": ""
}
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({
question_text: '<string>',
is_required: true,
sort_order: 0,
question_type: 'open_ended',
options: ['<string>'],
component_config: {},
follow_up_rule: 'auto',
follow_up_guideline: '',
requires_screen_share: false,
screen_share_prompt: ''
})
};
fetch('https://api.ontora.com/v1/interviews/{interview_id}/question-sets/{set_id}/questions', 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/{interview_id}/question-sets/{set_id}/questions",
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([
'question_text' => '<string>',
'is_required' => true,
'sort_order' => 0,
'question_type' => 'open_ended',
'options' => [
'<string>'
],
'component_config' => [
],
'follow_up_rule' => 'auto',
'follow_up_guideline' => '',
'requires_screen_share' => false,
'screen_share_prompt' => ''
]),
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/{interview_id}/question-sets/{set_id}/questions"
payload := strings.NewReader("{\n \"question_text\": \"<string>\",\n \"is_required\": true,\n \"sort_order\": 0,\n \"question_type\": \"open_ended\",\n \"options\": [\n \"<string>\"\n ],\n \"component_config\": {},\n \"follow_up_rule\": \"auto\",\n \"follow_up_guideline\": \"\",\n \"requires_screen_share\": false,\n \"screen_share_prompt\": \"\"\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/{interview_id}/question-sets/{set_id}/questions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"question_text\": \"<string>\",\n \"is_required\": true,\n \"sort_order\": 0,\n \"question_type\": \"open_ended\",\n \"options\": [\n \"<string>\"\n ],\n \"component_config\": {},\n \"follow_up_rule\": \"auto\",\n \"follow_up_guideline\": \"\",\n \"requires_screen_share\": false,\n \"screen_share_prompt\": \"\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ontora.com/v1/interviews/{interview_id}/question-sets/{set_id}/questions")
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 \"question_text\": \"<string>\",\n \"is_required\": true,\n \"sort_order\": 0,\n \"question_type\": \"open_ended\",\n \"options\": [\n \"<string>\"\n ],\n \"component_config\": {},\n \"follow_up_rule\": \"auto\",\n \"follow_up_guideline\": \"\",\n \"requires_screen_share\": false,\n \"screen_share_prompt\": \"\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"question_set_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"question_text": "<string>",
"is_required": true,
"sort_order": 123,
"question_type": "open_ended",
"options": [
"<string>"
],
"follow_up_rule": "auto",
"created_at": "2023-11-07T05:31:56Z",
"component_config": {},
"follow_up_guideline": "",
"requires_screen_share": false,
"screen_share_prompt": ""
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}interviews
Add Question To Set
Add a single question to an existing question set.
POST
/
v1
/
interviews
/
{interview_id}
/
question-sets
/
{set_id}
/
questions
Add Question To Set
curl --request POST \
--url https://api.ontora.com/v1/interviews/{interview_id}/question-sets/{set_id}/questions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"question_text": "<string>",
"is_required": true,
"sort_order": 0,
"question_type": "open_ended",
"options": [
"<string>"
],
"component_config": {},
"follow_up_rule": "auto",
"follow_up_guideline": "",
"requires_screen_share": false,
"screen_share_prompt": ""
}
'import requests
url = "https://api.ontora.com/v1/interviews/{interview_id}/question-sets/{set_id}/questions"
payload = {
"question_text": "<string>",
"is_required": True,
"sort_order": 0,
"question_type": "open_ended",
"options": ["<string>"],
"component_config": {},
"follow_up_rule": "auto",
"follow_up_guideline": "",
"requires_screen_share": False,
"screen_share_prompt": ""
}
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({
question_text: '<string>',
is_required: true,
sort_order: 0,
question_type: 'open_ended',
options: ['<string>'],
component_config: {},
follow_up_rule: 'auto',
follow_up_guideline: '',
requires_screen_share: false,
screen_share_prompt: ''
})
};
fetch('https://api.ontora.com/v1/interviews/{interview_id}/question-sets/{set_id}/questions', 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/{interview_id}/question-sets/{set_id}/questions",
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([
'question_text' => '<string>',
'is_required' => true,
'sort_order' => 0,
'question_type' => 'open_ended',
'options' => [
'<string>'
],
'component_config' => [
],
'follow_up_rule' => 'auto',
'follow_up_guideline' => '',
'requires_screen_share' => false,
'screen_share_prompt' => ''
]),
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/{interview_id}/question-sets/{set_id}/questions"
payload := strings.NewReader("{\n \"question_text\": \"<string>\",\n \"is_required\": true,\n \"sort_order\": 0,\n \"question_type\": \"open_ended\",\n \"options\": [\n \"<string>\"\n ],\n \"component_config\": {},\n \"follow_up_rule\": \"auto\",\n \"follow_up_guideline\": \"\",\n \"requires_screen_share\": false,\n \"screen_share_prompt\": \"\"\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/{interview_id}/question-sets/{set_id}/questions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"question_text\": \"<string>\",\n \"is_required\": true,\n \"sort_order\": 0,\n \"question_type\": \"open_ended\",\n \"options\": [\n \"<string>\"\n ],\n \"component_config\": {},\n \"follow_up_rule\": \"auto\",\n \"follow_up_guideline\": \"\",\n \"requires_screen_share\": false,\n \"screen_share_prompt\": \"\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ontora.com/v1/interviews/{interview_id}/question-sets/{set_id}/questions")
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 \"question_text\": \"<string>\",\n \"is_required\": true,\n \"sort_order\": 0,\n \"question_type\": \"open_ended\",\n \"options\": [\n \"<string>\"\n ],\n \"component_config\": {},\n \"follow_up_rule\": \"auto\",\n \"follow_up_guideline\": \"\",\n \"requires_screen_share\": false,\n \"screen_share_prompt\": \"\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"question_set_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"question_text": "<string>",
"is_required": true,
"sort_order": 123,
"question_type": "open_ended",
"options": [
"<string>"
],
"follow_up_rule": "auto",
"created_at": "2023-11-07T05:31:56Z",
"component_config": {},
"follow_up_guideline": "",
"requires_screen_share": false,
"screen_share_prompt": ""
}{
"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
Shape of an interview question — drives how the agent delivers and how answers get quantified.
Available options:
open_ended, single_choice, multiple_choice, likert_scale, ranking, statement, range_slider, matrix Per-question follow-up budget — controls how aggressively the agent probes.
Available options:
auto, none, on_short_answers, one_followup, up_to_three, no_followup_allowed Response
Successful Response
Shape of an interview question — drives how the agent delivers and how answers get quantified.
Available options:
open_ended, single_choice, multiple_choice, likert_scale, ranking, statement, range_slider, matrix Per-question follow-up budget — controls how aggressively the agent probes.
Available options:
auto, none, on_short_answers, one_followup, up_to_three, no_followup_allowed Was this page helpful?