Retrieve agent configuration
curl --request GET \
--url https://api.proficientai.com/agents/{agent_id}/config \
--header 'Key: <api-key>'import requests
url = "https://api.proficientai.com/agents/{agent_id}/config"
headers = {"Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Key: '<api-key>'}};
fetch('https://api.proficientai.com/agents/{agent_id}/config', 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/{agent_id}/config",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.proficientai.com/agents/{agent_id}/config"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.proficientai.com/agents/{agent_id}/config")
.header("Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.proficientai.com/agents/{agent_id}/config")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"object": "agent_config",
"anthropic": {
"temperature": 123,
"top_k": 123,
"top_p": 123
},
"agent_id": "<string>",
"greeting_message": "<string>",
"initial_turn": "user",
"model": "anthropic.claude-v1",
"openai": {
"frequency_penalty": 123,
"presence_penalty": 123,
"temperature": 123,
"top_p": 123
},
"system_message": "<string>"
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}Agents
Retrieve agent configuration
Retrieves the current configuration of the specified agent.
GET
/
agents
/
{agent_id}
/
config
Retrieve agent configuration
curl --request GET \
--url https://api.proficientai.com/agents/{agent_id}/config \
--header 'Key: <api-key>'import requests
url = "https://api.proficientai.com/agents/{agent_id}/config"
headers = {"Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Key: '<api-key>'}};
fetch('https://api.proficientai.com/agents/{agent_id}/config', 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/{agent_id}/config",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.proficientai.com/agents/{agent_id}/config"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.proficientai.com/agents/{agent_id}/config")
.header("Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.proficientai.com/agents/{agent_id}/config")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"object": "agent_config",
"anthropic": {
"temperature": 123,
"top_k": 123,
"top_p": 123
},
"agent_id": "<string>",
"greeting_message": "<string>",
"initial_turn": "user",
"model": "anthropic.claude-v1",
"openai": {
"frequency_penalty": 123,
"presence_penalty": 123,
"temperature": 123,
"top_p": 123
},
"system_message": "<string>"
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}Response
Represents the current configuration of the agent. This is an admin-level resource that is not exposed to the users.
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.

