Skip to main content
POST
/
agents
/
{agent_id}
/
config
Update agent configuration
curl --request POST \
  --url https://api.proficientai.com/agents/{agent_id}/config \
  --header 'Content-Type: application/json' \
  --data '{
  "anthropic": {
    "temperature": 123,
    "top_k": 123,
    "top_p": 123
  },
  "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>"
}'
{
  "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>"
}

Path Parameters

​
agent_id
string
required

The unique identifier of the agent

Body

application/json

The data with which an AgentConfig is updated.

​
anthropic
object | null

The configuration that is applied to Anthropic models.

​
greeting_message
string | null
<p>The message sent by the agent to initiate an interaction. This property supports <a href="https://handlebarsjs.com/guide/#what-is-handlebars">Handlebars</a> template format where you have access to the <code>user</code> and <code>agent</code> parameters. You can use these parameters to add context and personalize the message.</p>
​
initial_turn
enum<string> | null

Indicates who sends the first message in each interaction. Defaults to "user".

Available options:
user,
agent
​
model
enum<string> | null

The underlying model that powers the agent.

Available options:
anthropic.claude-v1,
anthropic.claude-v1-100k,
anthropic.claude-instant-v1,
anthropic.claude-instant-v1-100k,
openai.gpt-4,
openai.gpt-3.5-turbo,
openai.gpt-3.5-turbo-16k
​
openai
object | null

The configuration that is applied to OpenAI models.

​
system_message
string | null
<p>The system prompt that will be injected at the beginning of each interaction. This property supports <a href="https://handlebarsjs.com/guide/#what-is-handlebars">Handlebars</a> template format where you have access to the <code>user</code> and <code>agent</code> parameters. You can use these parameters to provide rich context to the agent and steer it in a specific direction.</p>

Response

Represents the current configuration of the agent. This is an admin-level resource that is not exposed to the users.

​
object
enum<string>
required

The type of the AgentConfig object

Available options:
agent_config
​
anthropic
object
required

The configuration that is applied to Anthropic models.

​
agent_id
string
required

The unique identifier of the agent

​
greeting_message
string
required
<p>The message sent by the agent to initiate an interaction. This property supports <a href="https://handlebarsjs.com/guide/#what-is-handlebars">Handlebars</a> template format where you have access to the <code>user</code> and <code>agent</code> parameters. You can use these parameters to add context and personalize the message.</p>
​
initial_turn
enum<string>
required

Indicates who sends the first message in each interaction. Defaults to "user".

Available options:
user,
agent
​
model
enum<string>
required

The underlying model that powers the agent.

Available options:
anthropic.claude-v1,
anthropic.claude-v1-100k,
anthropic.claude-instant-v1,
anthropic.claude-instant-v1-100k,
openai.gpt-4,
openai.gpt-3.5-turbo,
openai.gpt-3.5-turbo-16k
​
openai
object
required

The configuration that is applied to OpenAI models.

​
system_message
string
required
<p>The system prompt that will be injected at the beginning of each interaction. This property supports <a href="https://handlebarsjs.com/guide/#what-is-handlebars">Handlebars</a> template format where you have access to the <code>user</code> and <code>agent</code> parameters. You can use these parameters to provide rich context to the agent and steer it in a specific direction.</p>