Assistants API
The Assistants API allows you to interact with AI assistants that can process messages, maintain conversation history, and provide specialized capabilities.Capabilities
- Message Processing: Send messages and receive AI responses
- Chat History: Maintain and retrieve conversation history
- Specializations: Use different assistant configurations for different use cases
- Custom Models: Override LLM provider and model per request
- Tagging: Organize conversations with tags
Key Concepts
Assistant Specialization
Assistant Specializations define how an assistant behaves, what tools it can use, and how it processes messages.| Property | Description |
|---|---|
identifier | Unique identifier used in API paths |
name | Display name |
presets | System prompt / instructions |
availableToolsGroupsUids | Tool group IDs the assistant can use |
model / provider | Default LLM configuration |
accessConfiguration | Visibility and external access settings |
Chat History
Conversations are stored and can be continued by providing achatUid:
Endpoints Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1/assistants | List all assistant specializations |
| GET | /api/v1/assistants/:identifier | Get specific assistant |
| POST | /api/v1/assistants/:identifier/messages | Send message to assistant |
| GET | /api/v1/assistants/:identifier/chats | List chat histories |
| GET | /api/v1/assistants/:identifier/chats/:chatUid | Get specific chat |
| POST | /api/v1/assistants/chats | Get all chats with filters |
| GET | /api/v1/assistants/tags | Get unique tags |
Example: Send a Message
Response
Example: Custom Model
Override the default LLM for a specific request:Example: List Chat Histories
Supported Providers
When sending messages, you can specify custom providers and models:| Provider | Description |
|---|---|
openai | OpenAI API |
anthropic | Anthropic API |
azure | Azure OpenAI |
google | Google AI (Gemini) |
Access Configuration
Control visibility and external API access:externalAccess: true- Makes the assistant available via the public APIvisibilityByRole- Controls which user roles can see/use the assistant
See Also
- Agents API - For autonomous task execution
- API Reference - Full API documentation