Skip to main content
POST
/
api
/
agents
Create Agent
curl --request POST \
  --url https://api.getello.ai/api/agents \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{}'
import requests

url = "https://api.getello.ai/api/agents"

payload = {}
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({})
};

fetch('https://api.getello.ai/api/agents', 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.getello.ai/api/agents",
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([

]),
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://api.getello.ai/api/agents"

payload := strings.NewReader("{}")

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://api.getello.ai/api/agents")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.getello.ai/api/agents")

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 = "{}"

response = http.request(request)
puts response.read_body
{
  "status": 200,
  "message": "agent created successfully",
  "data": {
    "_id": "69cf98f0643b415327cab0af",
    "workspaceId": "6970c2f3948cfbce1932d99d",
    "userId": "6970c2f3948cfbce1932d99c",
    "name": "My Hybrid Agent",
    "type": "hybrid"
  }
}
{
"status": 400,
"message": "Validation Error",
"errors": [
{
"field": "body.type",
"message": "\"type\" is required"
}
]
}
{
"status": 401,
"message": "Unauthorized access"
}
{
"status": 403,
"message": "<string>"
}
{
"status": 404,
"message": "Prompt template not found"
}
{
"status": 500,
"message": "Error while creating agent",
"error": {
"details": "Some internal error message"
}
}

Authorizations

X-API-Key
string
header
required

Body

application/json
type
enum<string>
required
Available options:
inbound,
outbound,
chat,
hybrid
Example:

"hybrid"

workspaceId
string
Example:

"6970c2f3948cfbce1932d99d"

templateId
string
Example:

"69cf92ec643b415327cab0ae"

timezone
string
Example:

"Asia/Kolkata"

dynamic_variables
string[]
Example:
["customer_name", "order_id"]
metaData
object

Response

Agent created successfully

status
integer
Example:

200

message
string
Example:

"agent created successfully"

data
object
Example:
{
"_id": "69cf98f0643b415327cab0af",
"workspaceId": "6970c2f3948cfbce1932d99d",
"userId": "6970c2f3948cfbce1932d99c",
"name": "My Hybrid Agent",
"type": "hybrid"
}