curl --request POST \
--url http://localhost:8080/training \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"content": "<string>",
"is_draft": true,
"directory_id": "<string>",
"restricted_to_channels": [],
"restricted_to_segments": [
"<string>"
],
"metadata": {},
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z"
}
'import requests
url = "http://localhost:8080/training"
payload = {
"title": "<string>",
"content": "<string>",
"is_draft": True,
"directory_id": "<string>",
"restricted_to_channels": [],
"restricted_to_segments": ["<string>"],
"metadata": {},
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z"
}
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({
title: '<string>',
content: '<string>',
is_draft: true,
directory_id: '<string>',
restricted_to_channels: [],
restricted_to_segments: ['<string>'],
metadata: {},
start_time: '2023-11-07T05:31:56Z',
end_time: '2023-11-07T05:31:56Z'
})
};
fetch('http://localhost:8080/training', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/training",
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([
'title' => '<string>',
'content' => '<string>',
'is_draft' => true,
'directory_id' => '<string>',
'restricted_to_channels' => [
],
'restricted_to_segments' => [
'<string>'
],
'metadata' => [
],
'start_time' => '2023-11-07T05:31:56Z',
'end_time' => '2023-11-07T05:31:56Z'
]),
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 := "http://localhost:8080/training"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"is_draft\": true,\n \"directory_id\": \"<string>\",\n \"restricted_to_channels\": [],\n \"restricted_to_segments\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\"\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("http://localhost:8080/training")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"is_draft\": true,\n \"directory_id\": \"<string>\",\n \"restricted_to_channels\": [],\n \"restricted_to_segments\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/training")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"is_draft\": true,\n \"directory_id\": \"<string>\",\n \"restricted_to_channels\": [],\n \"restricted_to_segments\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"title": "<string>",
"content": "<string>",
"draft_title": "<string>",
"draft_content": "<string>",
"type": "BEHAVIORAL",
"is_draft": true,
"directory_id": "<string>",
"restricted_to_channels": [
"web"
],
"restricted_to_segments": [
"<string>"
],
"current_version": 123,
"metadata": {},
"published_at": "2023-11-07T05:31:56Z",
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Create a training
Create a new training scenario. Use when pushing training scenarios or knowledge into the AI training index from an external pipeline.
curl --request POST \
--url http://localhost:8080/training \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"content": "<string>",
"is_draft": true,
"directory_id": "<string>",
"restricted_to_channels": [],
"restricted_to_segments": [
"<string>"
],
"metadata": {},
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z"
}
'import requests
url = "http://localhost:8080/training"
payload = {
"title": "<string>",
"content": "<string>",
"is_draft": True,
"directory_id": "<string>",
"restricted_to_channels": [],
"restricted_to_segments": ["<string>"],
"metadata": {},
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z"
}
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({
title: '<string>',
content: '<string>',
is_draft: true,
directory_id: '<string>',
restricted_to_channels: [],
restricted_to_segments: ['<string>'],
metadata: {},
start_time: '2023-11-07T05:31:56Z',
end_time: '2023-11-07T05:31:56Z'
})
};
fetch('http://localhost:8080/training', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/training",
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([
'title' => '<string>',
'content' => '<string>',
'is_draft' => true,
'directory_id' => '<string>',
'restricted_to_channels' => [
],
'restricted_to_segments' => [
'<string>'
],
'metadata' => [
],
'start_time' => '2023-11-07T05:31:56Z',
'end_time' => '2023-11-07T05:31:56Z'
]),
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 := "http://localhost:8080/training"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"is_draft\": true,\n \"directory_id\": \"<string>\",\n \"restricted_to_channels\": [],\n \"restricted_to_segments\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\"\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("http://localhost:8080/training")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"is_draft\": true,\n \"directory_id\": \"<string>\",\n \"restricted_to_channels\": [],\n \"restricted_to_segments\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/training")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"is_draft\": true,\n \"directory_id\": \"<string>\",\n \"restricted_to_channels\": [],\n \"restricted_to_segments\": [\n \"<string>\"\n ],\n \"metadata\": {},\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"title": "<string>",
"content": "<string>",
"draft_title": "<string>",
"draft_content": "<string>",
"type": "BEHAVIORAL",
"is_draft": true,
"directory_id": "<string>",
"restricted_to_channels": [
"web"
],
"restricted_to_segments": [
"<string>"
],
"current_version": 123,
"metadata": {},
"published_at": "2023-11-07T05:31:56Z",
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The scenario title or trigger phrase
The instruction body — how the AI should respond
BEHAVIORAL (always active) or SCENARIO_SPECIFIC (semantic match, default)
BEHAVIORAL, SCENARIO_SPECIFIC If true, saved as draft and not used by the AI
Directory ID to organize into
Limit to specific channels (empty = all)
web, email, phone_voice, slack, sms, whatsapp, instagram, messenger, api, web_voice, twitter, twitter_mentions, app_review, internal Limit to specific segments (empty = all)
Arbitrary key-value metadata for external integrations
Show child attributes
Show child attributes
ISO 8601 instant (UTC) when the AI may start using this instruction. Null clears the start bound.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ISO 8601 instant (UTC) when the AI stops using this instruction. Null clears the end bound.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Response
Default Response
Unique training ID
The scenario title or trigger phrase (last published version)
The instruction body — how the AI should respond (last published version)
Draft title being edited (null if no draft exists). Use draft_title ?? title.
Draft body being edited (null if no draft exists). Use draft_content ?? content.
BEHAVIORAL (always active) or SCENARIO_SPECIFIC (semantic match)
BEHAVIORAL, SCENARIO_SPECIFIC Draft trainings are saved but not used by the AI
Directory this training belongs to
Channels this applies to (empty = all)
web, email, phone_voice, slack, sms, whatsapp, instagram, messenger, api, web_voice, twitter, twitter_mentions, app_review, internal Contact segments this applies to (empty = all)
Active published version number (null if unpublished draft)
Arbitrary key-value metadata for external integrations
Show child attributes
Show child attributes
When the current version was published
Active window start (UTC). Null = no start bound.
Active window end (UTC). Null = no end bound.
Was this page helpful?