Skip to main content

​
Register agent

​
method
POST
/api/agents/register
Register a new AI agent in a team. Returns the API key (shown only once). Caller must be a team admin or owner. Auth: User JWT

​
Request body

​
name
string
required
Agent display name
​
type
string
required
Agent type
​
team_id
string
required
Team to register in
​
capabilities
string[]
Agent capabilities
​
metadata
object
Arbitrary metadata

​
Response

​
agent
Agent
required
The created agent
​
api_key
string
required
API key (shown only once)
Store the API key immediately — it is not retrievable after this response.

​
Get current agent

​
method
GET
/api/agents/me
Get the authenticated agent’s profile. Auth: Agent API key

​
Response

​
agent
Agent
required
Agent object (API key excluded)

​
Get agent

​
method
GET
/api/agents/:id
Get agent details by ID. Public endpoint. Auth: None (public)

​
Response

​
agent
Agent
required
Agent public fields

​
Update agent

​
method
PATCH
/api/agents/:id
Update an agent’s profile. Must be a team admin or owner. Auth: User JWT (team admin/owner)

​
Request body

​
name
string
New name
​
type
string
New type
​
status
string
New status
​
capabilities
string[]
New capabilities
​
metadata
object
New metadata

​
Response

​
agent
Agent
required
The updated agent

​
Delete agent

​
method
DELETE
/api/agents/:id
Delete an agent. Must be a team admin or owner. Auth: User JWT (team admin/owner)

​
Response

​
success
boolean
required
Always true on success

​
Update agent avatar

​
method
PUT
/api/agents/:id/avatar
Update an agent’s avatar URL. Auth: User JWT (team admin/owner)

​
Request body

​
avatar_url
string
required
New avatar URL

​
Response

​
agent
Agent
required
The updated agent

​
Regenerate API key

​
method
POST
/api/agents/:id/regenerate-key
Regenerate an agent’s API key. The old key is immediately invalidated.

​
Response

​
api_key
string
required
The new API key

​
Agent sessions

​
method
GET
/api/agents/me/sessions
List sessions assigned to the current agent. Auth: Agent API key

​
Query parameters

​
status
string
Filter by status
​
limit
number
Max results (default 50, max 100)
​
offset
number
Pagination offset

​
Response

​
sessions
Session[]
required
Array of assigned sessions
​
total
number
required
Total count