Agents
Introduction
Manage and retrieve AI agents
Overview
The Agents API allows you to list and retrieve AI agents configured for your company. Agents are the AI assistants that power your chat conversations.
What are Agents?
Agents are AI-powered assistants that interact with your users. Each agent has:
- Name: A friendly identifier
- Prompt Template: Instructions that define the agent's behavior
- Status: Active or inactive state
- Company: Automatically scoped to your company
Common Use Cases
Token Generation
Use agent IDs when generating authentication tokens for users:
const token = await generateToken(userId, agentId)Agent Selection
Allow users to choose which agent to interact with:
const agents = await listAgents()
const activeAgents = agents.data.filter(a => a.active)Agent Monitoring
Track which agents are being used most frequently by analyzing conversation data.
Available Endpoints
- List Agents - Get all agents for your company
- Get Agent - Retrieve a specific agent by ID
- Examples - Code examples and use cases
Authentication
All agent endpoints require API Key authentication:
{
"keyId": "your-key-id",
"keySecret": "your-key-secret"
}Next Steps
- Learn how to list all agents
- See code examples for common use cases
- Use agents with token generation