API Overview
Agents API
Parameters full description
Note
You can find below the full description of Parameters for each POST/PATCH/GET/DELETE methods and also what parameters you can expect from the API responses.
If you want to play with the API, please see the Agents API playground.
If you want to play with the API, please see the Agents API playground.
POST - Create a new agent
POST - Create a new agent
Parameters:
agentName String
Name of the agentagentPurpose String
Purpose of the agentformatting String
Output formatting instructionsagentPersonality String
Personality of the agentagentPolicyRules String
Policy rules for the agentcontextUids String[]
Array of existing context Uids (max 30)mcpserverUids String[]
Array of existing mcpserver Uids (max 5)tags String[]
Array of tags (max 10). You will be able to view reports based grouping or filtering of activity according to the tags applied when creating the agent.PATCH - Update an existing agent
PATCH - Update an existing agent
Parameters:
agentName String
Name of the agentagentPurpose String
Purpose of the agentformatting String
Output formatting instructionsagentPersonality String
Personality of the agentagentPolicyRules String
Policy rules for the agentlive Boolean
Set the agent status: live or not livecontextUids String[]
Array of existing context Uids (max 30)mcpserverUids String[]
Array of existing mcpserver Uids (max 5)tags String[]
Array of tags (max 10). You will be able to view reports based grouping or filtering of activity according to the tags applied when creating the agent.GET - Query the list of agents
GET - Query the list of agents
Parameters:
startAfter - Querying for “the next page” String
Use thestartAfter parameter and provide the createdAt string of the last agent in the current results set
When there are no more results you will receive an empty array in the response and a 404 status codecontextUid String
Filter results to a specific contextUid (cannot be used with mcpserverUid)mcpserverUid String
Filter results to a specific mcpserverUid (cannot be used with contextUid)DELETE - Delete an agent by providing its uid
DELETE - Delete an agent by providing its uid
RESPONSE DATA
RESPONSE DATA
You will get the same response data when calling POST, PATCH or GET.Note: When retrieving a collection of agents, the response will be an array of objects.