Agents
Retrieve agent configuration
Agents
Retrieve agent configuration
Retrieves the current configuration of the specified agent.
GET
/
agents
/
{agent_id}
/
config
Path Parameters
agent_id
string
requiredThe 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>
requiredThe type of the AgentConfig object
Available options:
agent_config anthropic
object
requiredThe configuration that is applied to Anthropic models.
agent_id
string
requiredThe 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>
requiredIndicates who sends the first message in each interaction. Defaults to "user".
Available options:
user, agent model
enum<string>
requiredThe 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
requiredThe 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>