Retrieve agent configuration

GET

agents

{agent_id}

config

curl --request GET \
  --url https://api.proficientai.com/agents/{agent_id}/config

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

Response

200

application/json

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

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.

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.

openai.frequency_penalty

number | null

Can take values between -2.0 and 2.0, with positive values penalizing the model for generating new tokens that have already appeared frequently in the generated text so far. This reduces the likelihood of the model repeating the same line or phrase verbatim. In essence, a higher positive value for <code>frequency_penalty</code> encourages the model to use less frequently used tokens in the generated text. See original <a href="https://platform.openai.com/docs/api-reference/completions/create#completions/create-frequency_penalty">definition</a>.

openai.presence_penalty

number | null

Can take values between -2.0 and 2.0, with positive values penalizing the model for generating new tokens that have already appeared in the generated text. This encourages the model to generate text about new topics and increases the likelihood of generating more diverse content. In essence, a higher positive value for <code>presence_penalty</code> will lead to more avoidance of repeating previously used tokens in the generated text. See original <a href="https://platform.openai.com/docs/api-reference/completions/create#completions/create-presence_penalty">definition</a>.

openai.temperature

number | null

Determines the level of randomness in the generated output. Can take values between 0 and 2.0, with higher values like 0.8 resulting in more randomness, and lower values like 0.2 making the output more predictable. See original <a href="https://platform.openai.com/docs/api-reference/completions/create#completions/create-temperature">definition</a>.

openai.top_p

number | null

An alternative to the <code>temperature</code> option. Uses a method called nucleus sampling, which involves considering only the tokens with the highest probability mass. It specifies the proportion of the probability mass to consider, with a value of 0.1 indicating that only the tokens comprising the top 10% probability mass will be taken into account. In essence, <code>top_p</code> determines the size of the set of tokens to choose from, based on their probabilities. See original <a href="https://platform.openai.com/docs/api-reference/completions/create#completions/create-top_p">definition</a>.

system_message

string

required

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.

Delete an agent Update agent configuration

curl --request GET \
  --url https://api.proficientai.com/agents/{agent_id}/config

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

Admin API

Agents

Users

Path Parameters

Response