Skip to main content
GET
List agents

Authorizations

Authorization
string
header
required

JWT token from Clerk authentication.

Must be from a user with org:admin role.

Response

Successfully retrieved agents

id
integer
required

Unique agent identifier

Example:

1

name
string
required

Agent name

Example:

"Customer Support Agent"

stage
enum<string>
required

Agent lifecycle stage

Available options:
development,
released
Example:

"development"

showInChat
boolean
required

Whether the agent appears in the chat interface

Example:

true

createdAt
string<date-time>
required

When the agent was created

Example:

"2024-01-15T10:30:00.000Z"

updatedAt
string<date-time>
required

When the agent was last updated

Example:

"2024-01-20T14:00:00.000Z"

description
string | null

Short description of the agent's purpose

Example:

"Handles customer inquiries and support tickets"

logoUrl
string | null

URL to the agent's logo image

conversationStarters
string[] | null

Suggested conversation starters shown to users

Example:
model
string | null

Model identifier (e.g., openai:gpt-4o)

Example:

"openai:gpt-4o"

maxToolRoundtrips
integer | null

Maximum number of tool call roundtrips per response

Example:

50

systemPrompt
string | null

System prompt / instructions for the agent

tools
object | null

Tool definitions keyed by tool name

mcpServers
integer[] | null

Connected MCP server IDs (integer mcp_server.id values)

emailSlug
string | null

Custom email slug for the agent's email address

Example:

"support-bot"

publishedVersionId
integer | null

ID of the agent_version snapshot this agent's config currently reflects. Every save appends a version and advances this pointer; see GET /agents/versions. The live agent fields above remain the source of truth — this is bookkeeping for history and rollback.

Example:

42

tags
object[]

Tags associated with this agent