curl --request POST \
--url https://api.proficientai.com/agents \
--header 'Content-Type: application/json' \
--header 'Key: <api-key>' \
--data '
{
"description": "<string>",
"display_description": "<string>",
"display_name": "<string>",
"greeting_message": "<string>",
"name": "<string>",
"openai": {
"frequency_penalty": 123,
"presence_penalty": 123,
"temperature": 123,
"top_p": 123
},
"system_message": "<string>"
}
'import requests
url = "https://api.proficientai.com/agents"
payload = {
"description": "<string>",
"display_description": "<string>",
"display_name": "<string>",
"greeting_message": "<string>",
"name": "<string>",
"openai": {
"frequency_penalty": 123,
"presence_penalty": 123,
"temperature": 123,
"top_p": 123
},
"system_message": "<string>"
}
headers = {
"Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
display_description: '<string>',
display_name: '<string>',
greeting_message: '<string>',
name: '<string>',
openai: {frequency_penalty: 123, presence_penalty: 123, temperature: 123, top_p: 123},
system_message: '<string>'
})
};
fetch('https://api.proficientai.com/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.proficientai.com/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([
'description' => '<string>',
'display_description' => '<string>',
'display_name' => '<string>',
'greeting_message' => '<string>',
'name' => '<string>',
'openai' => [
'frequency_penalty' => 123,
'presence_penalty' => 123,
'temperature' => 123,
'top_p' => 123
],
'system_message' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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.proficientai.com/agents"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"display_description\": \"<string>\",\n \"display_name\": \"<string>\",\n \"greeting_message\": \"<string>\",\n \"name\": \"<string>\",\n \"openai\": {\n \"frequency_penalty\": 123,\n \"presence_penalty\": 123,\n \"temperature\": 123,\n \"top_p\": 123\n },\n \"system_message\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("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.proficientai.com/agents")
.header("Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"display_description\": \"<string>\",\n \"display_name\": \"<string>\",\n \"greeting_message\": \"<string>\",\n \"name\": \"<string>\",\n \"openai\": {\n \"frequency_penalty\": 123,\n \"presence_penalty\": 123,\n \"temperature\": 123,\n \"top_p\": 123\n },\n \"system_message\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.proficientai.com/agents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"display_description\": \"<string>\",\n \"display_name\": \"<string>\",\n \"greeting_message\": \"<string>\",\n \"name\": \"<string>\",\n \"openai\": {\n \"frequency_penalty\": 123,\n \"presence_penalty\": 123,\n \"temperature\": 123,\n \"top_p\": 123\n },\n \"system_message\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"object": "agent",
"active": true,
"description": "<string>",
"display_description": "<string>",
"display_name": "<string>",
"name": "<string>",
"created_at": 123,
"updated_at": 123
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}Create an agent
Creates a new agent with the given properties.
curl --request POST \
--url https://api.proficientai.com/agents \
--header 'Content-Type: application/json' \
--header 'Key: <api-key>' \
--data '
{
"description": "<string>",
"display_description": "<string>",
"display_name": "<string>",
"greeting_message": "<string>",
"name": "<string>",
"openai": {
"frequency_penalty": 123,
"presence_penalty": 123,
"temperature": 123,
"top_p": 123
},
"system_message": "<string>"
}
'import requests
url = "https://api.proficientai.com/agents"
payload = {
"description": "<string>",
"display_description": "<string>",
"display_name": "<string>",
"greeting_message": "<string>",
"name": "<string>",
"openai": {
"frequency_penalty": 123,
"presence_penalty": 123,
"temperature": 123,
"top_p": 123
},
"system_message": "<string>"
}
headers = {
"Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
display_description: '<string>',
display_name: '<string>',
greeting_message: '<string>',
name: '<string>',
openai: {frequency_penalty: 123, presence_penalty: 123, temperature: 123, top_p: 123},
system_message: '<string>'
})
};
fetch('https://api.proficientai.com/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.proficientai.com/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([
'description' => '<string>',
'display_description' => '<string>',
'display_name' => '<string>',
'greeting_message' => '<string>',
'name' => '<string>',
'openai' => [
'frequency_penalty' => 123,
'presence_penalty' => 123,
'temperature' => 123,
'top_p' => 123
],
'system_message' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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.proficientai.com/agents"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"display_description\": \"<string>\",\n \"display_name\": \"<string>\",\n \"greeting_message\": \"<string>\",\n \"name\": \"<string>\",\n \"openai\": {\n \"frequency_penalty\": 123,\n \"presence_penalty\": 123,\n \"temperature\": 123,\n \"top_p\": 123\n },\n \"system_message\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("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.proficientai.com/agents")
.header("Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"display_description\": \"<string>\",\n \"display_name\": \"<string>\",\n \"greeting_message\": \"<string>\",\n \"name\": \"<string>\",\n \"openai\": {\n \"frequency_penalty\": 123,\n \"presence_penalty\": 123,\n \"temperature\": 123,\n \"top_p\": 123\n },\n \"system_message\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.proficientai.com/agents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"display_description\": \"<string>\",\n \"display_name\": \"<string>\",\n \"greeting_message\": \"<string>\",\n \"name\": \"<string>\",\n \"openai\": {\n \"frequency_penalty\": 123,\n \"presence_penalty\": 123,\n \"temperature\": 123,\n \"top_p\": 123\n },\n \"system_message\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"object": "agent",
"active": true,
"description": "<string>",
"display_description": "<string>",
"display_name": "<string>",
"name": "<string>",
"created_at": 123,
"updated_at": 123
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}Body
The data with which an agent is created.
The message sent by the agent to initiate an interaction. This property supports Handlebars template format where you have access to the user and agent parameters. You can use these parameters to add context and personalize the message.
The system prompt that will be injected at the beginning of each interaction. This property supports Handlebars template format where you have access to the user and agent parameters. You can use these parameters to provide rich context to the agent and steer it in a specific direction.
Response
An _agent_ is an AI entity that exists to serve your project's users. Agents are intelligent, configurable and context-aware and can interact with your users via a messaging system enabled by the Proficient API.

