Skip to content

Agents

List of valid attributes:

AttributeDescriptionSpecifics
activeIs AI Agent active or notMust be true or false
descriptionHuman readable explanation-
discarded_atNull or timestamp of removalCannot be set
nameName of the agentMust be set

Meta data: Permissions

GroupDescription
actionsContains permissions to edit an agent

Update

This endpoint updates an agent.

HTTP Request

PUT /api/v1/agents/:agent_id

URL Parameters

ParameterDescription
agent_idThe ID of the agent to update

Response:

{
"data": {
"id": "61bbbd38-8640-4fdf-b446-b1660c32988e",
"type": "agent",
"attributes": {
...
}
}
}

List

This endpoint returns all agents of current user’s account.

HTTP Request

GET /api/v1/agents

Response

{
"data": [
{
"id": "61bbbd38-8640-4fdf-b446-b1660c32988e",
"type": "agent",
"attributes": {
...
}
},
{
...
}
]
}