REST API Reference
elizaOS Cloud provides a comprehensive REST API for all platform features.
Looking for a full, route-by-route explorer? Go to API Explorer →
Base URL
https://cloud.milady.ai/api/v1Authentication
All API requests require authentication via API key or session token:
curl -X GET "https://cloud.milady.ai/api/v1/dashboard" \
-H "Authorization: Bearer YOUR_API_KEY"Get your API key from Dashboard → API Keys
Authentication Methods
| Method | Header | Use Case |
|---|---|---|
| API Key | Authorization: Bearer ek_xxx | Server-to-server |
| X-API-Key | X-API-Key: ek_xxx | Alternative header |
| Session | Cookie-based | Browser applications |
API Categories
OpenAI-compatible chat API with streaming support
Chat CompletionsAnthropic-compatible messages API for Claude Code and SDK clients
MessagesGenerate vector embeddings for text
EmbeddingsCreate images from text prompts
Image GenerationGenerate videos from prompts
Video GenerationManage AI agents and characters
AgentsUpload and query documents
KnowledgeCreate and manage applications
AppsDeploy and monitor containers
ContainersError Handling
All errors follow a consistent format:
{
"error": {
"code": "INVALID_REQUEST",
"message": "The request body is invalid",
"details": "Field 'model' is required"
}
}Error Codes
| Code | HTTP Status | Description |
|---|---|---|
UNAUTHORIZED | 401 | Invalid or missing authentication |
FORBIDDEN | 403 | Insufficient permissions |
NOT_FOUND | 404 | Resource not found |
RATE_LIMITED | 429 | Too many requests |
INSUFFICIENT_CREDITS | 402 | Not enough credits |
INTERNAL_ERROR | 500 | Server error |
Rate Limits
| Endpoint | Rate Limit |
|---|---|
| Chat completions | 60 req/min |
| Embeddings | 100 req/min |
| Image generation | 20 req/min |
| Video generation | 5 req/min |
Rate limits can be increased for enterprise plans. Contact sales for details.
OpenAPI Specification
The full OpenAPI specification is available at:
https://cloud.milady.ai/api/openapi.jsonYou can use this with tools like Swagger UI, Postman, or to generate client SDKs.