Skip to main content
POST
/
public
/
v1
/
agents
/
create
Create agent
curl --request POST \
  --url https://api.callin.io/api/public/v1/agents/create \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "My Agent",
  "conversationConfig": {
    "agent": {
      "prompt": {
        "prompt": "You are a helpful assistant."
      }
    }
  }
}
'
import requests

url = "https://api.callin.io/api/public/v1/agents/create"

payload = {
"name": "My Agent",
"conversationConfig": { "agent": { "prompt": { "prompt": "You are a helpful assistant." } } }
}
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({
name: 'My Agent',
conversationConfig: {agent: {prompt: {prompt: 'You are a helpful assistant.'}}}
})
};

fetch('https://api.callin.io/api/public/v1/agents/create', 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.callin.io/api/public/v1/agents/create",
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' => 'My Agent',
'conversationConfig' => [
'agent' => [
'prompt' => [
'prompt' => 'You are a helpful assistant.'
]
]
]
]),
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.callin.io/api/public/v1/agents/create"

payload := strings.NewReader("{\n \"name\": \"My Agent\",\n \"conversationConfig\": {\n \"agent\": {\n \"prompt\": {\n \"prompt\": \"You are a helpful assistant.\"\n }\n }\n }\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://api.callin.io/api/public/v1/agents/create")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"My Agent\",\n \"conversationConfig\": {\n \"agent\": {\n \"prompt\": {\n \"prompt\": \"You are a helpful assistant.\"\n }\n }\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.callin.io/api/public/v1/agents/create")

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 \"name\": \"My Agent\",\n \"conversationConfig\": {\n \"agent\": {\n \"prompt\": {\n \"prompt\": \"You are a helpful assistant.\"\n }\n }\n }\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "agentId": "<string>"
  }
}
{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"fields": [
{}
]
}
}

Authorizations

x-api-key
string
header
required

Send your Callin API key in the x-api-key header.

Body

application/json

Create-agent payload (createPublicAgentSchema): name, direction, tags, nested conversationConfig and platformSettings.

name
string
required

Display name for the agent.

conversationConfig
object
required
direction
enum<string>

Whether the agent handles outbound calls, inbound calls, or both. Defaults to outbound.

Available options:
outbound,
inbound,
both
tags
string[]

Tags for organizing agents.

platformSettings
object

The platform settings of the agent

Response

Agent created successfully. Returns the new agent data.

After creating an agent, use data.agentId in follow-up calls.

success
boolean
Example:

true

data
object