API Overview
The AMAS API is organized around REST principles. It accepts JSON and YAML-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.Base URL
All API requests should be made to:
API Versioning
The current API version is
v1. All endpoints are prefixed with /api/v1/.For a comprehensive interactive API reference, visit the Swagger Documentation.
Key Concepts
Agents
Agents
Agents are AI-powered entities configured with specific capabilities, instructions, and behaviors. AMAS supports two types: LLM Agents (conversational) and ReAct Agents (tool-using, reasoning agents).
Sessions
Sessions
A session represents a conversation instance with an agent. Each session maintains its own message history and state. Sessions are created with a complete agent configuration in YAML or JSON format.
Runtime
Runtime
The Runtime API allows you to execute messages in sessions and interact with agents in real-time. Send user messages, retrieve agent responses, access conversation history, and monitor execution status with detailed metadata and usage statistics.
Knowledge Bases
Knowledge Bases
Knowledge bases provide agents with access to domain-specific information through semantic search. AMAS supports Milvus vector database for production-ready retrieval.
Collections & Files
Collections & Files
Files are uploaded documents that can be organized into collections. Collections group related data sources for knowledge base ingestion and management.
Getting Started
1
Get your API key
Contact your administrator or use the dashboard to generate an API key.
2
Validate your agent configuration
Test your agent configuration before creating a session:
3
Create a session and execute
Create a session with your configuration and start executing messages: