Create agent
curl --request POST \
--url https://api.naturalead.ai/api/agent-config \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"systemPrompt": "<string>",
"language": "<string>",
"goal": "<string>",
"instructions": "<string>",
"qualificationCriteria": "<string>",
"handoffMessage": "<string>",
"stages": [
{
"id": "<string>",
"name": "<string>",
"order": 123,
"prompt": "<string>",
"transitionCriteria": "<string>",
"maxMessages": 0,
"nextStages": [
{
"id": "<string>",
"condition": "<string>"
}
],
"nextStageIds": [
"<string>"
],
"knowledgeBaseIds": [
"<string>"
],
"stageInsights": [
{
"fieldName": "<string>",
"instructions": "<string>"
}
],
"position": {
"x": 123,
"y": 123
}
}
],
"inboundEntries": [
{
"targetStageId": "<string>",
"condition": "<string>"
}
],
"guardrails": {
"maxTotalMessages": 40,
"inactivityTimeoutMinutes": 1440,
"forbiddenTopics": "",
"escalationTriggers": ""
},
"knowledgeBaseIds": [
"<string>"
],
"mcpServerIds": [
"<string>"
]
}
'import requests
url = "https://api.naturalead.ai/api/agent-config"
payload = {
"name": "<string>",
"systemPrompt": "<string>",
"language": "<string>",
"goal": "<string>",
"instructions": "<string>",
"qualificationCriteria": "<string>",
"handoffMessage": "<string>",
"stages": [
{
"id": "<string>",
"name": "<string>",
"order": 123,
"prompt": "<string>",
"transitionCriteria": "<string>",
"maxMessages": 0,
"nextStages": [
{
"id": "<string>",
"condition": "<string>"
}
],
"nextStageIds": ["<string>"],
"knowledgeBaseIds": ["<string>"],
"stageInsights": [
{
"fieldName": "<string>",
"instructions": "<string>"
}
],
"position": {
"x": 123,
"y": 123
}
}
],
"inboundEntries": [
{
"targetStageId": "<string>",
"condition": "<string>"
}
],
"guardrails": {
"maxTotalMessages": 40,
"inactivityTimeoutMinutes": 1440,
"forbiddenTopics": "",
"escalationTriggers": ""
},
"knowledgeBaseIds": ["<string>"],
"mcpServerIds": ["<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({
name: '<string>',
systemPrompt: '<string>',
language: '<string>',
goal: '<string>',
instructions: '<string>',
qualificationCriteria: '<string>',
handoffMessage: '<string>',
stages: [
{
id: '<string>',
name: '<string>',
order: 123,
prompt: '<string>',
transitionCriteria: '<string>',
maxMessages: 0,
nextStages: [{id: '<string>', condition: '<string>'}],
nextStageIds: ['<string>'],
knowledgeBaseIds: ['<string>'],
stageInsights: [{fieldName: '<string>', instructions: '<string>'}],
position: {x: 123, y: 123}
}
],
inboundEntries: [{targetStageId: '<string>', condition: '<string>'}],
guardrails: {
maxTotalMessages: 40,
inactivityTimeoutMinutes: 1440,
forbiddenTopics: '',
escalationTriggers: ''
},
knowledgeBaseIds: ['<string>'],
mcpServerIds: ['<string>']
})
};
fetch('https://api.naturalead.ai/api/agent-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.naturalead.ai/api/agent-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([
'name' => '<string>',
'systemPrompt' => '<string>',
'language' => '<string>',
'goal' => '<string>',
'instructions' => '<string>',
'qualificationCriteria' => '<string>',
'handoffMessage' => '<string>',
'stages' => [
[
'id' => '<string>',
'name' => '<string>',
'order' => 123,
'prompt' => '<string>',
'transitionCriteria' => '<string>',
'maxMessages' => 0,
'nextStages' => [
[
'id' => '<string>',
'condition' => '<string>'
]
],
'nextStageIds' => [
'<string>'
],
'knowledgeBaseIds' => [
'<string>'
],
'stageInsights' => [
[
'fieldName' => '<string>',
'instructions' => '<string>'
]
],
'position' => [
'x' => 123,
'y' => 123
]
]
],
'inboundEntries' => [
[
'targetStageId' => '<string>',
'condition' => '<string>'
]
],
'guardrails' => [
'maxTotalMessages' => 40,
'inactivityTimeoutMinutes' => 1440,
'forbiddenTopics' => '',
'escalationTriggers' => ''
],
'knowledgeBaseIds' => [
'<string>'
],
'mcpServerIds' => [
'<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.naturalead.ai/api/agent-config"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"systemPrompt\": \"<string>\",\n \"language\": \"<string>\",\n \"goal\": \"<string>\",\n \"instructions\": \"<string>\",\n \"qualificationCriteria\": \"<string>\",\n \"handoffMessage\": \"<string>\",\n \"stages\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"order\": 123,\n \"prompt\": \"<string>\",\n \"transitionCriteria\": \"<string>\",\n \"maxMessages\": 0,\n \"nextStages\": [\n {\n \"id\": \"<string>\",\n \"condition\": \"<string>\"\n }\n ],\n \"nextStageIds\": [\n \"<string>\"\n ],\n \"knowledgeBaseIds\": [\n \"<string>\"\n ],\n \"stageInsights\": [\n {\n \"fieldName\": \"<string>\",\n \"instructions\": \"<string>\"\n }\n ],\n \"position\": {\n \"x\": 123,\n \"y\": 123\n }\n }\n ],\n \"inboundEntries\": [\n {\n \"targetStageId\": \"<string>\",\n \"condition\": \"<string>\"\n }\n ],\n \"guardrails\": {\n \"maxTotalMessages\": 40,\n \"inactivityTimeoutMinutes\": 1440,\n \"forbiddenTopics\": \"\",\n \"escalationTriggers\": \"\"\n },\n \"knowledgeBaseIds\": [\n \"<string>\"\n ],\n \"mcpServerIds\": [\n \"<string>\"\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.naturalead.ai/api/agent-config")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"systemPrompt\": \"<string>\",\n \"language\": \"<string>\",\n \"goal\": \"<string>\",\n \"instructions\": \"<string>\",\n \"qualificationCriteria\": \"<string>\",\n \"handoffMessage\": \"<string>\",\n \"stages\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"order\": 123,\n \"prompt\": \"<string>\",\n \"transitionCriteria\": \"<string>\",\n \"maxMessages\": 0,\n \"nextStages\": [\n {\n \"id\": \"<string>\",\n \"condition\": \"<string>\"\n }\n ],\n \"nextStageIds\": [\n \"<string>\"\n ],\n \"knowledgeBaseIds\": [\n \"<string>\"\n ],\n \"stageInsights\": [\n {\n \"fieldName\": \"<string>\",\n \"instructions\": \"<string>\"\n }\n ],\n \"position\": {\n \"x\": 123,\n \"y\": 123\n }\n }\n ],\n \"inboundEntries\": [\n {\n \"targetStageId\": \"<string>\",\n \"condition\": \"<string>\"\n }\n ],\n \"guardrails\": {\n \"maxTotalMessages\": 40,\n \"inactivityTimeoutMinutes\": 1440,\n \"forbiddenTopics\": \"\",\n \"escalationTriggers\": \"\"\n },\n \"knowledgeBaseIds\": [\n \"<string>\"\n ],\n \"mcpServerIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.naturalead.ai/api/agent-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 \"name\": \"<string>\",\n \"systemPrompt\": \"<string>\",\n \"language\": \"<string>\",\n \"goal\": \"<string>\",\n \"instructions\": \"<string>\",\n \"qualificationCriteria\": \"<string>\",\n \"handoffMessage\": \"<string>\",\n \"stages\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"order\": 123,\n \"prompt\": \"<string>\",\n \"transitionCriteria\": \"<string>\",\n \"maxMessages\": 0,\n \"nextStages\": [\n {\n \"id\": \"<string>\",\n \"condition\": \"<string>\"\n }\n ],\n \"nextStageIds\": [\n \"<string>\"\n ],\n \"knowledgeBaseIds\": [\n \"<string>\"\n ],\n \"stageInsights\": [\n {\n \"fieldName\": \"<string>\",\n \"instructions\": \"<string>\"\n }\n ],\n \"position\": {\n \"x\": 123,\n \"y\": 123\n }\n }\n ],\n \"inboundEntries\": [\n {\n \"targetStageId\": \"<string>\",\n \"condition\": \"<string>\"\n }\n ],\n \"guardrails\": {\n \"maxTotalMessages\": 40,\n \"inactivityTimeoutMinutes\": 1440,\n \"forbiddenTopics\": \"\",\n \"escalationTriggers\": \"\"\n },\n \"knowledgeBaseIds\": [\n \"<string>\"\n ],\n \"mcpServerIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"_id": "<string>",
"accountId": "<string>",
"name": "<string>",
"systemPrompt": "<string>",
"goal": "<string>",
"status": "active",
"language": "English",
"instructions": "<string>",
"qualificationCriteria": "<string>",
"handoffMessage": "I'll connect you with a specialist who can help further!",
"stages": [
{
"id": "<string>",
"name": "<string>",
"order": 123,
"prompt": "<string>",
"transitionCriteria": "<string>",
"maxMessages": 0,
"nextStages": [
{
"id": "<string>",
"condition": "<string>"
}
],
"nextStageIds": [
"<string>"
],
"knowledgeBaseIds": [
"<string>"
],
"stageInsights": [
{
"fieldName": "<string>",
"instructions": "<string>"
}
],
"position": {
"x": 123,
"y": 123
}
}
],
"inboundEntries": [
{
"targetStageId": "<string>",
"condition": "<string>"
}
],
"guardrails": {
"maxTotalMessages": 40,
"inactivityTimeoutMinutes": 1440,
"forbiddenTopics": "",
"escalationTriggers": ""
},
"knowledgeBaseIds": [
"<string>"
],
"mcpServerIds": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"error": "<string>"
}Agent Config
Create Agent
Creates a new agent configuration for the current account.
Requires agent_config:edit permission.
POST
/
api
/
agent-config
Create agent
curl --request POST \
--url https://api.naturalead.ai/api/agent-config \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"systemPrompt": "<string>",
"language": "<string>",
"goal": "<string>",
"instructions": "<string>",
"qualificationCriteria": "<string>",
"handoffMessage": "<string>",
"stages": [
{
"id": "<string>",
"name": "<string>",
"order": 123,
"prompt": "<string>",
"transitionCriteria": "<string>",
"maxMessages": 0,
"nextStages": [
{
"id": "<string>",
"condition": "<string>"
}
],
"nextStageIds": [
"<string>"
],
"knowledgeBaseIds": [
"<string>"
],
"stageInsights": [
{
"fieldName": "<string>",
"instructions": "<string>"
}
],
"position": {
"x": 123,
"y": 123
}
}
],
"inboundEntries": [
{
"targetStageId": "<string>",
"condition": "<string>"
}
],
"guardrails": {
"maxTotalMessages": 40,
"inactivityTimeoutMinutes": 1440,
"forbiddenTopics": "",
"escalationTriggers": ""
},
"knowledgeBaseIds": [
"<string>"
],
"mcpServerIds": [
"<string>"
]
}
'import requests
url = "https://api.naturalead.ai/api/agent-config"
payload = {
"name": "<string>",
"systemPrompt": "<string>",
"language": "<string>",
"goal": "<string>",
"instructions": "<string>",
"qualificationCriteria": "<string>",
"handoffMessage": "<string>",
"stages": [
{
"id": "<string>",
"name": "<string>",
"order": 123,
"prompt": "<string>",
"transitionCriteria": "<string>",
"maxMessages": 0,
"nextStages": [
{
"id": "<string>",
"condition": "<string>"
}
],
"nextStageIds": ["<string>"],
"knowledgeBaseIds": ["<string>"],
"stageInsights": [
{
"fieldName": "<string>",
"instructions": "<string>"
}
],
"position": {
"x": 123,
"y": 123
}
}
],
"inboundEntries": [
{
"targetStageId": "<string>",
"condition": "<string>"
}
],
"guardrails": {
"maxTotalMessages": 40,
"inactivityTimeoutMinutes": 1440,
"forbiddenTopics": "",
"escalationTriggers": ""
},
"knowledgeBaseIds": ["<string>"],
"mcpServerIds": ["<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({
name: '<string>',
systemPrompt: '<string>',
language: '<string>',
goal: '<string>',
instructions: '<string>',
qualificationCriteria: '<string>',
handoffMessage: '<string>',
stages: [
{
id: '<string>',
name: '<string>',
order: 123,
prompt: '<string>',
transitionCriteria: '<string>',
maxMessages: 0,
nextStages: [{id: '<string>', condition: '<string>'}],
nextStageIds: ['<string>'],
knowledgeBaseIds: ['<string>'],
stageInsights: [{fieldName: '<string>', instructions: '<string>'}],
position: {x: 123, y: 123}
}
],
inboundEntries: [{targetStageId: '<string>', condition: '<string>'}],
guardrails: {
maxTotalMessages: 40,
inactivityTimeoutMinutes: 1440,
forbiddenTopics: '',
escalationTriggers: ''
},
knowledgeBaseIds: ['<string>'],
mcpServerIds: ['<string>']
})
};
fetch('https://api.naturalead.ai/api/agent-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.naturalead.ai/api/agent-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([
'name' => '<string>',
'systemPrompt' => '<string>',
'language' => '<string>',
'goal' => '<string>',
'instructions' => '<string>',
'qualificationCriteria' => '<string>',
'handoffMessage' => '<string>',
'stages' => [
[
'id' => '<string>',
'name' => '<string>',
'order' => 123,
'prompt' => '<string>',
'transitionCriteria' => '<string>',
'maxMessages' => 0,
'nextStages' => [
[
'id' => '<string>',
'condition' => '<string>'
]
],
'nextStageIds' => [
'<string>'
],
'knowledgeBaseIds' => [
'<string>'
],
'stageInsights' => [
[
'fieldName' => '<string>',
'instructions' => '<string>'
]
],
'position' => [
'x' => 123,
'y' => 123
]
]
],
'inboundEntries' => [
[
'targetStageId' => '<string>',
'condition' => '<string>'
]
],
'guardrails' => [
'maxTotalMessages' => 40,
'inactivityTimeoutMinutes' => 1440,
'forbiddenTopics' => '',
'escalationTriggers' => ''
],
'knowledgeBaseIds' => [
'<string>'
],
'mcpServerIds' => [
'<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.naturalead.ai/api/agent-config"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"systemPrompt\": \"<string>\",\n \"language\": \"<string>\",\n \"goal\": \"<string>\",\n \"instructions\": \"<string>\",\n \"qualificationCriteria\": \"<string>\",\n \"handoffMessage\": \"<string>\",\n \"stages\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"order\": 123,\n \"prompt\": \"<string>\",\n \"transitionCriteria\": \"<string>\",\n \"maxMessages\": 0,\n \"nextStages\": [\n {\n \"id\": \"<string>\",\n \"condition\": \"<string>\"\n }\n ],\n \"nextStageIds\": [\n \"<string>\"\n ],\n \"knowledgeBaseIds\": [\n \"<string>\"\n ],\n \"stageInsights\": [\n {\n \"fieldName\": \"<string>\",\n \"instructions\": \"<string>\"\n }\n ],\n \"position\": {\n \"x\": 123,\n \"y\": 123\n }\n }\n ],\n \"inboundEntries\": [\n {\n \"targetStageId\": \"<string>\",\n \"condition\": \"<string>\"\n }\n ],\n \"guardrails\": {\n \"maxTotalMessages\": 40,\n \"inactivityTimeoutMinutes\": 1440,\n \"forbiddenTopics\": \"\",\n \"escalationTriggers\": \"\"\n },\n \"knowledgeBaseIds\": [\n \"<string>\"\n ],\n \"mcpServerIds\": [\n \"<string>\"\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.naturalead.ai/api/agent-config")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"systemPrompt\": \"<string>\",\n \"language\": \"<string>\",\n \"goal\": \"<string>\",\n \"instructions\": \"<string>\",\n \"qualificationCriteria\": \"<string>\",\n \"handoffMessage\": \"<string>\",\n \"stages\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"order\": 123,\n \"prompt\": \"<string>\",\n \"transitionCriteria\": \"<string>\",\n \"maxMessages\": 0,\n \"nextStages\": [\n {\n \"id\": \"<string>\",\n \"condition\": \"<string>\"\n }\n ],\n \"nextStageIds\": [\n \"<string>\"\n ],\n \"knowledgeBaseIds\": [\n \"<string>\"\n ],\n \"stageInsights\": [\n {\n \"fieldName\": \"<string>\",\n \"instructions\": \"<string>\"\n }\n ],\n \"position\": {\n \"x\": 123,\n \"y\": 123\n }\n }\n ],\n \"inboundEntries\": [\n {\n \"targetStageId\": \"<string>\",\n \"condition\": \"<string>\"\n }\n ],\n \"guardrails\": {\n \"maxTotalMessages\": 40,\n \"inactivityTimeoutMinutes\": 1440,\n \"forbiddenTopics\": \"\",\n \"escalationTriggers\": \"\"\n },\n \"knowledgeBaseIds\": [\n \"<string>\"\n ],\n \"mcpServerIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.naturalead.ai/api/agent-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 \"name\": \"<string>\",\n \"systemPrompt\": \"<string>\",\n \"language\": \"<string>\",\n \"goal\": \"<string>\",\n \"instructions\": \"<string>\",\n \"qualificationCriteria\": \"<string>\",\n \"handoffMessage\": \"<string>\",\n \"stages\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"order\": 123,\n \"prompt\": \"<string>\",\n \"transitionCriteria\": \"<string>\",\n \"maxMessages\": 0,\n \"nextStages\": [\n {\n \"id\": \"<string>\",\n \"condition\": \"<string>\"\n }\n ],\n \"nextStageIds\": [\n \"<string>\"\n ],\n \"knowledgeBaseIds\": [\n \"<string>\"\n ],\n \"stageInsights\": [\n {\n \"fieldName\": \"<string>\",\n \"instructions\": \"<string>\"\n }\n ],\n \"position\": {\n \"x\": 123,\n \"y\": 123\n }\n }\n ],\n \"inboundEntries\": [\n {\n \"targetStageId\": \"<string>\",\n \"condition\": \"<string>\"\n }\n ],\n \"guardrails\": {\n \"maxTotalMessages\": 40,\n \"inactivityTimeoutMinutes\": 1440,\n \"forbiddenTopics\": \"\",\n \"escalationTriggers\": \"\"\n },\n \"knowledgeBaseIds\": [\n \"<string>\"\n ],\n \"mcpServerIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"_id": "<string>",
"accountId": "<string>",
"name": "<string>",
"systemPrompt": "<string>",
"goal": "<string>",
"status": "active",
"language": "English",
"instructions": "<string>",
"qualificationCriteria": "<string>",
"handoffMessage": "I'll connect you with a specialist who can help further!",
"stages": [
{
"id": "<string>",
"name": "<string>",
"order": 123,
"prompt": "<string>",
"transitionCriteria": "<string>",
"maxMessages": 0,
"nextStages": [
{
"id": "<string>",
"condition": "<string>"
}
],
"nextStageIds": [
"<string>"
],
"knowledgeBaseIds": [
"<string>"
],
"stageInsights": [
{
"fieldName": "<string>",
"instructions": "<string>"
}
],
"position": {
"x": 123,
"y": 123
}
}
],
"inboundEntries": [
{
"targetStageId": "<string>",
"condition": "<string>"
}
],
"guardrails": {
"maxTotalMessages": 40,
"inactivityTimeoutMinutes": 1440,
"forbiddenTopics": "",
"escalationTriggers": ""
},
"knowledgeBaseIds": [
"<string>"
],
"mcpServerIds": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"error": "<string>"
}Authorizations
Bearer token using an API key (format nl_live_* or nl_test_*)
Body
application/json
Request body for creating or updating an agent configuration. All fields are optional on update.
Agent display name
Available options:
active, inactive, draft System prompt sent to the LLM
Conversation language
High-level goal for the agent
Additional instructions
Deprecated. Ignored by the conversation engine.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Created agent configuration
MongoDB ObjectId
Account ObjectId this agent belongs to
Agent display name
System prompt sent to the LLM for every conversation
High-level goal for the agent
Available options:
active, inactive, draft Conversation language
Additional instructions for the agent
Deprecated. Ignored by the conversation engine. Journey outcomes are terminal stages (no outgoing edges); advancement uses transitionCriteria and nextStages edge conditions.
Message sent when the conversation is handed off to a human
Ordered conversation stages
Show child attributes
Show child attributes
First-touch inbound landings (WhatsApp). Evaluated only when a conversation is created from an inbound message — not on later replies. Empty condition is the default landing.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
ObjectIds of attached knowledge bases
ObjectIds of attached MCP servers. Populated as full objects (minus
credentials) on GET /api/agent-config/{id}. Managed through the
dedicated attach/detach endpoints; sending it on create or update
also works and is validated for account ownership.