Agents
Create BYOA
Creates a new Bring Your Own Agent (BYOA)
POST
/
api
/
v1
/
agents
/
byoa
/
cURL
curl --request POST \
--url https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/agents/byoa/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"webhookUrl": "<string>"
}
'import requests
url = "https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/agents/byoa/"
payload = { "webhookUrl": "<string>" }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({webhookUrl: '<string>'})
};
fetch('https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/agents/byoa/', 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://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/agents/byoa/",
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([
'webhookUrl' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/agents/byoa/"
payload := strings.NewReader("{\n \"webhookUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/agents/byoa/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"webhookUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/agents/byoa/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"webhookUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"systemPrompt": "<string>",
"firstMessage": "<string>",
"profilePicture": "<string>",
"tools": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"apiSchema": "<unknown>",
"creditCost": 123,
"active": true
}
],
"documents": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"file": "<string>",
"status": "<string>"
}
],
"memoryKeys": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "<string>",
"type": "<string>",
"initialValue": "<string>",
"whenToUpdate": "<string>"
}
],
"wakeUpConfigs": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"forceMessage": true,
"enabled": true
}
],
"outboundTriggers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "<string>",
"templateId": "<string>",
"templateName": "<string>",
"secret": "<string>",
"enabled": true
}
],
"websiteTools": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "<string>",
"prompt": "<string>",
"active": true
}
],
"imageGenerateTools": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt": "<string>",
"creditCost": 123,
"name": "<string>",
"description": "<string>",
"active": true
}
],
"handoffTools": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parentAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"childAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"childAgentName": "<string>",
"description": "<string>",
"active": true
}
],
"mcpConfigs": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"connectorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"connectorName": "<string>",
"toolWhitelist": "<unknown>"
}
],
"paywallConfig": "<string>",
"adConfig": "<string>",
"creditSettings": "<string>",
"voiceCallConfig": "<string>",
"owner": "<string>",
"sharings": "<string>",
"phoneNumbers": [
{
"whatsappPhoneNumberId": "<string>",
"whatsappBusinessAccountId": "<string>",
"wabaId": "<string>",
"phoneNumber": "<string>"
}
],
"totalMessages": "<string>",
"totalSessions": "<string>",
"connectUrl": "<string>",
"ownerActive": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"icebreakers": "<unknown>",
"llmModel": "<string>"
}This endpoint lets you create a new Bring Your Own Agent (BYOA).
See BYOA Agent for more information.
Authorizations
API key authentication. Pass your API key in the X-API-Key header.
Body
application/json
Input serializer for creating a Bring Your Own Agent (BYOA) agent.
The webhook URL where messages will be forwarded
Response
201 - application/json
Maximum string length:
255Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I
cURL
curl --request POST \
--url https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/agents/byoa/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"webhookUrl": "<string>"
}
'import requests
url = "https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/agents/byoa/"
payload = { "webhookUrl": "<string>" }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({webhookUrl: '<string>'})
};
fetch('https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/agents/byoa/', 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://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/agents/byoa/",
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([
'webhookUrl' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/agents/byoa/"
payload := strings.NewReader("{\n \"webhookUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/agents/byoa/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"webhookUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://alpha-plagiocephalic-darrell.ngrok-free.dev/api/v1/agents/byoa/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"webhookUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"systemPrompt": "<string>",
"firstMessage": "<string>",
"profilePicture": "<string>",
"tools": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"apiSchema": "<unknown>",
"creditCost": 123,
"active": true
}
],
"documents": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"file": "<string>",
"status": "<string>"
}
],
"memoryKeys": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "<string>",
"type": "<string>",
"initialValue": "<string>",
"whenToUpdate": "<string>"
}
],
"wakeUpConfigs": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"forceMessage": true,
"enabled": true
}
],
"outboundTriggers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "<string>",
"templateId": "<string>",
"templateName": "<string>",
"secret": "<string>",
"enabled": true
}
],
"websiteTools": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "<string>",
"prompt": "<string>",
"active": true
}
],
"imageGenerateTools": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt": "<string>",
"creditCost": 123,
"name": "<string>",
"description": "<string>",
"active": true
}
],
"handoffTools": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parentAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"childAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"childAgentName": "<string>",
"description": "<string>",
"active": true
}
],
"mcpConfigs": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"connectorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"connectorName": "<string>",
"toolWhitelist": "<unknown>"
}
],
"paywallConfig": "<string>",
"adConfig": "<string>",
"creditSettings": "<string>",
"voiceCallConfig": "<string>",
"owner": "<string>",
"sharings": "<string>",
"phoneNumbers": [
{
"whatsappPhoneNumberId": "<string>",
"whatsappBusinessAccountId": "<string>",
"wabaId": "<string>",
"phoneNumber": "<string>"
}
],
"totalMessages": "<string>",
"totalSessions": "<string>",
"connectUrl": "<string>",
"ownerActive": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"icebreakers": "<unknown>",
"llmModel": "<string>"
}