Translate Campaign Content Endpoint
curl --request POST \
--url https://api.ontora.com/v1/campaign-creation/{interview_id}/translate-content \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"target_language": "<string>",
"content": {
"interview_context_for_employee": "",
"welcome_screen": "",
"closing_message": "",
"invitation_email_message": "",
"teams_invitation_message": "",
"topics": [
{
"id": "<string>",
"name": "",
"goal": "",
"questions": [
{
"id": "<string>",
"text": "",
"options": [
"<string>"
],
"follow_up_guideline": "",
"screen_share_prompt": "",
"component_config": {}
}
]
}
]
}
}
'import requests
url = "https://api.ontora.com/v1/campaign-creation/{interview_id}/translate-content"
payload = {
"target_language": "<string>",
"content": {
"interview_context_for_employee": "",
"welcome_screen": "",
"closing_message": "",
"invitation_email_message": "",
"teams_invitation_message": "",
"topics": [
{
"id": "<string>",
"name": "",
"goal": "",
"questions": [
{
"id": "<string>",
"text": "",
"options": ["<string>"],
"follow_up_guideline": "",
"screen_share_prompt": "",
"component_config": {}
}
]
}
]
}
}
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({
target_language: '<string>',
content: {
interview_context_for_employee: '',
welcome_screen: '',
closing_message: '',
invitation_email_message: '',
teams_invitation_message: '',
topics: [
{
id: '<string>',
name: '',
goal: '',
questions: [
{
id: '<string>',
text: '',
options: ['<string>'],
follow_up_guideline: '',
screen_share_prompt: '',
component_config: {}
}
]
}
]
}
})
};
fetch('https://api.ontora.com/v1/campaign-creation/{interview_id}/translate-content', 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/campaign-creation/{interview_id}/translate-content",
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([
'target_language' => '<string>',
'content' => [
'interview_context_for_employee' => '',
'welcome_screen' => '',
'closing_message' => '',
'invitation_email_message' => '',
'teams_invitation_message' => '',
'topics' => [
[
'id' => '<string>',
'name' => '',
'goal' => '',
'questions' => [
[
'id' => '<string>',
'text' => '',
'options' => [
'<string>'
],
'follow_up_guideline' => '',
'screen_share_prompt' => '',
'component_config' => [
]
]
]
]
]
]
]),
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/campaign-creation/{interview_id}/translate-content"
payload := strings.NewReader("{\n \"target_language\": \"<string>\",\n \"content\": {\n \"interview_context_for_employee\": \"\",\n \"welcome_screen\": \"\",\n \"closing_message\": \"\",\n \"invitation_email_message\": \"\",\n \"teams_invitation_message\": \"\",\n \"topics\": [\n {\n \"id\": \"<string>\",\n \"name\": \"\",\n \"goal\": \"\",\n \"questions\": [\n {\n \"id\": \"<string>\",\n \"text\": \"\",\n \"options\": [\n \"<string>\"\n ],\n \"follow_up_guideline\": \"\",\n \"screen_share_prompt\": \"\",\n \"component_config\": {}\n }\n ]\n }\n ]\n }\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/campaign-creation/{interview_id}/translate-content")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"target_language\": \"<string>\",\n \"content\": {\n \"interview_context_for_employee\": \"\",\n \"welcome_screen\": \"\",\n \"closing_message\": \"\",\n \"invitation_email_message\": \"\",\n \"teams_invitation_message\": \"\",\n \"topics\": [\n {\n \"id\": \"<string>\",\n \"name\": \"\",\n \"goal\": \"\",\n \"questions\": [\n {\n \"id\": \"<string>\",\n \"text\": \"\",\n \"options\": [\n \"<string>\"\n ],\n \"follow_up_guideline\": \"\",\n \"screen_share_prompt\": \"\",\n \"component_config\": {}\n }\n ]\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ontora.com/v1/campaign-creation/{interview_id}/translate-content")
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 \"target_language\": \"<string>\",\n \"content\": {\n \"interview_context_for_employee\": \"\",\n \"welcome_screen\": \"\",\n \"closing_message\": \"\",\n \"invitation_email_message\": \"\",\n \"teams_invitation_message\": \"\",\n \"topics\": [\n {\n \"id\": \"<string>\",\n \"name\": \"\",\n \"goal\": \"\",\n \"questions\": [\n {\n \"id\": \"<string>\",\n \"text\": \"\",\n \"options\": [\n \"<string>\"\n ],\n \"follow_up_guideline\": \"\",\n \"screen_share_prompt\": \"\",\n \"component_config\": {}\n }\n ]\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"target_language": "<string>",
"content": {
"interview_context_for_employee": "",
"welcome_screen": "",
"closing_message": "",
"invitation_email_message": "",
"teams_invitation_message": "",
"topics": [
{
"id": "<string>",
"name": "",
"goal": "",
"questions": [
{
"id": "<string>",
"text": "",
"options": [
"<string>"
],
"follow_up_guideline": "",
"screen_share_prompt": "",
"component_config": {}
}
]
}
]
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}campaign-creation
Translate Campaign Content Endpoint
Translate the campaign’s participant-facing content into a language.
Pure transformation: the editor sends the content it currently holds and renders the result as a reviewable preview. Nothing is written here — applying is the organizer’s explicit second step, because this rewrites text they authored.
POST
/
v1
/
campaign-creation
/
{interview_id}
/
translate-content
Translate Campaign Content Endpoint
curl --request POST \
--url https://api.ontora.com/v1/campaign-creation/{interview_id}/translate-content \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"target_language": "<string>",
"content": {
"interview_context_for_employee": "",
"welcome_screen": "",
"closing_message": "",
"invitation_email_message": "",
"teams_invitation_message": "",
"topics": [
{
"id": "<string>",
"name": "",
"goal": "",
"questions": [
{
"id": "<string>",
"text": "",
"options": [
"<string>"
],
"follow_up_guideline": "",
"screen_share_prompt": "",
"component_config": {}
}
]
}
]
}
}
'import requests
url = "https://api.ontora.com/v1/campaign-creation/{interview_id}/translate-content"
payload = {
"target_language": "<string>",
"content": {
"interview_context_for_employee": "",
"welcome_screen": "",
"closing_message": "",
"invitation_email_message": "",
"teams_invitation_message": "",
"topics": [
{
"id": "<string>",
"name": "",
"goal": "",
"questions": [
{
"id": "<string>",
"text": "",
"options": ["<string>"],
"follow_up_guideline": "",
"screen_share_prompt": "",
"component_config": {}
}
]
}
]
}
}
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({
target_language: '<string>',
content: {
interview_context_for_employee: '',
welcome_screen: '',
closing_message: '',
invitation_email_message: '',
teams_invitation_message: '',
topics: [
{
id: '<string>',
name: '',
goal: '',
questions: [
{
id: '<string>',
text: '',
options: ['<string>'],
follow_up_guideline: '',
screen_share_prompt: '',
component_config: {}
}
]
}
]
}
})
};
fetch('https://api.ontora.com/v1/campaign-creation/{interview_id}/translate-content', 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/campaign-creation/{interview_id}/translate-content",
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([
'target_language' => '<string>',
'content' => [
'interview_context_for_employee' => '',
'welcome_screen' => '',
'closing_message' => '',
'invitation_email_message' => '',
'teams_invitation_message' => '',
'topics' => [
[
'id' => '<string>',
'name' => '',
'goal' => '',
'questions' => [
[
'id' => '<string>',
'text' => '',
'options' => [
'<string>'
],
'follow_up_guideline' => '',
'screen_share_prompt' => '',
'component_config' => [
]
]
]
]
]
]
]),
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/campaign-creation/{interview_id}/translate-content"
payload := strings.NewReader("{\n \"target_language\": \"<string>\",\n \"content\": {\n \"interview_context_for_employee\": \"\",\n \"welcome_screen\": \"\",\n \"closing_message\": \"\",\n \"invitation_email_message\": \"\",\n \"teams_invitation_message\": \"\",\n \"topics\": [\n {\n \"id\": \"<string>\",\n \"name\": \"\",\n \"goal\": \"\",\n \"questions\": [\n {\n \"id\": \"<string>\",\n \"text\": \"\",\n \"options\": [\n \"<string>\"\n ],\n \"follow_up_guideline\": \"\",\n \"screen_share_prompt\": \"\",\n \"component_config\": {}\n }\n ]\n }\n ]\n }\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/campaign-creation/{interview_id}/translate-content")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"target_language\": \"<string>\",\n \"content\": {\n \"interview_context_for_employee\": \"\",\n \"welcome_screen\": \"\",\n \"closing_message\": \"\",\n \"invitation_email_message\": \"\",\n \"teams_invitation_message\": \"\",\n \"topics\": [\n {\n \"id\": \"<string>\",\n \"name\": \"\",\n \"goal\": \"\",\n \"questions\": [\n {\n \"id\": \"<string>\",\n \"text\": \"\",\n \"options\": [\n \"<string>\"\n ],\n \"follow_up_guideline\": \"\",\n \"screen_share_prompt\": \"\",\n \"component_config\": {}\n }\n ]\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ontora.com/v1/campaign-creation/{interview_id}/translate-content")
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 \"target_language\": \"<string>\",\n \"content\": {\n \"interview_context_for_employee\": \"\",\n \"welcome_screen\": \"\",\n \"closing_message\": \"\",\n \"invitation_email_message\": \"\",\n \"teams_invitation_message\": \"\",\n \"topics\": [\n {\n \"id\": \"<string>\",\n \"name\": \"\",\n \"goal\": \"\",\n \"questions\": [\n {\n \"id\": \"<string>\",\n \"text\": \"\",\n \"options\": [\n \"<string>\"\n ],\n \"follow_up_guideline\": \"\",\n \"screen_share_prompt\": \"\",\n \"component_config\": {}\n }\n ]\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"target_language": "<string>",
"content": {
"interview_context_for_employee": "",
"welcome_screen": "",
"closing_message": "",
"invitation_email_message": "",
"teams_invitation_message": "",
"topics": [
{
"id": "<string>",
"name": "",
"goal": "",
"questions": [
{
"id": "<string>",
"text": "",
"options": [
"<string>"
],
"follow_up_guideline": "",
"screen_share_prompt": "",
"component_config": {}
}
]
}
]
}
}{
"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.
Path Parameters
Body
application/json
Was this page helpful?
⌘I