Create Agent
curl --request POST \
--url https://api.getoutbox.ai/agent/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"type": "chatbot",
"assistant_id": "<string>",
"description": "<string>",
"prompt": "<string>",
"first_message": "<string>",
"timezone": "<string>",
"webhook_url": "<string>",
"branding_colour": "<string>",
"model": "gpt-4.1"
}
'import requests
url = "https://api.getoutbox.ai/agent/"
payload = {
"name": "<string>",
"type": "chatbot",
"assistant_id": "<string>",
"description": "<string>",
"prompt": "<string>",
"first_message": "<string>",
"timezone": "<string>",
"webhook_url": "<string>",
"branding_colour": "<string>",
"model": "gpt-4.1"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
type: 'chatbot',
assistant_id: '<string>',
description: '<string>',
prompt: '<string>',
first_message: '<string>',
timezone: '<string>',
webhook_url: '<string>',
branding_colour: '<string>',
model: 'gpt-4.1'
})
};
fetch('https://api.getoutbox.ai/agent/', 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.getoutbox.ai/agent/",
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>',
'type' => 'chatbot',
'assistant_id' => '<string>',
'description' => '<string>',
'prompt' => '<string>',
'first_message' => '<string>',
'timezone' => '<string>',
'webhook_url' => '<string>',
'branding_colour' => '<string>',
'model' => 'gpt-4.1'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.getoutbox.ai/agent/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"type\": \"chatbot\",\n \"assistant_id\": \"<string>\",\n \"description\": \"<string>\",\n \"prompt\": \"<string>\",\n \"first_message\": \"<string>\",\n \"timezone\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"branding_colour\": \"<string>\",\n \"model\": \"gpt-4.1\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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://api.getoutbox.ai/agent/")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"type\": \"chatbot\",\n \"assistant_id\": \"<string>\",\n \"description\": \"<string>\",\n \"prompt\": \"<string>\",\n \"first_message\": \"<string>\",\n \"timezone\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"branding_colour\": \"<string>\",\n \"model\": \"gpt-4.1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoutbox.ai/agent/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"type\": \"chatbot\",\n \"assistant_id\": \"<string>\",\n \"description\": \"<string>\",\n \"prompt\": \"<string>\",\n \"first_message\": \"<string>\",\n \"timezone\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"branding_colour\": \"<string>\",\n \"model\": \"gpt-4.1\"\n}"
response = http.request(request)
puts response.read_body"<string>"Agent Endpoints
Create Agent
Create a new agent (chatbot or voicebot)
POST
/
agent
/
Create Agent
curl --request POST \
--url https://api.getoutbox.ai/agent/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"type": "chatbot",
"assistant_id": "<string>",
"description": "<string>",
"prompt": "<string>",
"first_message": "<string>",
"timezone": "<string>",
"webhook_url": "<string>",
"branding_colour": "<string>",
"model": "gpt-4.1"
}
'import requests
url = "https://api.getoutbox.ai/agent/"
payload = {
"name": "<string>",
"type": "chatbot",
"assistant_id": "<string>",
"description": "<string>",
"prompt": "<string>",
"first_message": "<string>",
"timezone": "<string>",
"webhook_url": "<string>",
"branding_colour": "<string>",
"model": "gpt-4.1"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
type: 'chatbot',
assistant_id: '<string>',
description: '<string>',
prompt: '<string>',
first_message: '<string>',
timezone: '<string>',
webhook_url: '<string>',
branding_colour: '<string>',
model: 'gpt-4.1'
})
};
fetch('https://api.getoutbox.ai/agent/', 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.getoutbox.ai/agent/",
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>',
'type' => 'chatbot',
'assistant_id' => '<string>',
'description' => '<string>',
'prompt' => '<string>',
'first_message' => '<string>',
'timezone' => '<string>',
'webhook_url' => '<string>',
'branding_colour' => '<string>',
'model' => 'gpt-4.1'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.getoutbox.ai/agent/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"type\": \"chatbot\",\n \"assistant_id\": \"<string>\",\n \"description\": \"<string>\",\n \"prompt\": \"<string>\",\n \"first_message\": \"<string>\",\n \"timezone\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"branding_colour\": \"<string>\",\n \"model\": \"gpt-4.1\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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://api.getoutbox.ai/agent/")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"type\": \"chatbot\",\n \"assistant_id\": \"<string>\",\n \"description\": \"<string>\",\n \"prompt\": \"<string>\",\n \"first_message\": \"<string>\",\n \"timezone\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"branding_colour\": \"<string>\",\n \"model\": \"gpt-4.1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoutbox.ai/agent/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"type\": \"chatbot\",\n \"assistant_id\": \"<string>\",\n \"description\": \"<string>\",\n \"prompt\": \"<string>\",\n \"first_message\": \"<string>\",\n \"timezone\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"branding_colour\": \"<string>\",\n \"model\": \"gpt-4.1\"\n}"
response = http.request(request)
puts response.read_body"<string>"Authorizations
Company API Key
Body
application/json
Agent creation details
- Chat Agent
- Voice Agent
Name of the agent
Agent type discriminator
Available options:
chatbot Internal assistant identifier (optional)
If present, used to generate the prompt
Used only if no description is provided
First message shown in supported chat surfaces
Timezone name (e.g. "America/New_York")
Webhook URL (if applicable)
"" or hex #RGB / #RRGGBB
Chat model name (defaults to gpt-4.1)
Response
Agent created successfully
The ID of the newly created agent
⌘I

