Retrieve Agent
Retrieve a JSON object of a single agent from agentId and the resourceSlug
Path Parameters
The resourceSlug is a url parameter of the teamId associated with the user
The url parameter with the Id of the agent to get
Response
An agent object used for tasks or apps
Unique Mongodb identifier for the object
Name of the agent
Fed into the LLM to help it provide a more detailed and correct response
The goal of the agent is fed into the LLM, this allows the LLM to know it's role in the RAG pipeline
A detailed description of what the LLM will be doing
The linked ObjectId of the model being used by this agent (this links to a Model object)
True or false check to determine if custom verbosity is used in agent, higher verbosity requires agent to include more of the retrieved documents at the expense of longer answers, lower verbosity can result in shorter answers but can also ommit crucial details
True or false check to determine if the agent is allowed to delegate tasks to other agents in the context of an app
Organisation the agent is linked to (generally the org of the user that created the agent)
Team the agent is linked to (generally the team of the user that created the agent)
A secondary model used to execute function calls (this links to a Model object), set to null if unused automatically by the API
Array of the tools the agent can access to improve performance and abstract tool functionality from agent usage
IconAttachment object used to hold the attached icon used for the agent (this links to an IconAttachment object);