API Overview
Complete API reference for ATOM SaaS platform endpoints.
---
Base URLs
**Production:**
- API:
https://[your-tenant].atomagentos.com/api - App:
https://[your-tenant].atomagentos.com
**Development:**
- Local:
http://localhost:3000 - Backend:
http://localhost:8000
---
Authentication
All API requests require authentication:
JWT Token Authentication
# Get token from login response
export TOKEN="your_jwt_token_here"
# Include in requests
curl -H "Authorization: Bearer $TOKEN" \
https://[your-tenant].atomagentos.com/api/v1/agentsAPI Key Authentication
# Use API key for service accounts
export API_KEY="your_api_key_here"
curl -H "X-API-Key: $API_KEY" \
https://api.atom.io/api/agents---
Rate Limiting
| Tier | Daily Limit | Per-Minute Limit |
|---|---|---|
| Free | 50/day | 60/min |
| Solo | 500/day | 100/min |
| Team | 5,000/day | 500/min |
| Enterprise | Unlimited | Custom |
**Headers returned:**
X-RateLimit-Limit: 500
X-RateLimit-Remaining: 450
X-RateLimit-Reset: 1707225600---
Response Format
All API responses follow this structure:
Success Response
{
"success": true,
"data": { ... },
"meta": {
"timestamp": "2025-02-06T10:00:00Z",
"request_id": "req_abc123"
}
}Error Response
{
"success": false,
"error": {
"code": "AGENT_NOT_FOUND",
"message": "Agent with ID 'xxx' not found",
"details": { ... }
},
"meta": {
"timestamp": "2025-02-06T10:00:00Z",
"request_id": "req_abc123"
}
}---
API Endpoints by Category
Agent Management
List, create, update, delete, and execute AI agents.
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/agents | List all agents |
| POST | /api/agents | Create new agent |
| GET | /api/agents/{id} | Get agent details |
| PUT | /api/agents/{id} | Update agent |
| DELETE | /api/agents/{id} | Delete agent |
| POST | /api/agents/{id}/execute | Execute agent task |
| GET | /api/agents/{id}/training | Get training status |
| POST | /api/agents/{id}/train | Train agent |
**Full Agent API Documentation →**
---
Graduation & Episodic Memory
Manage agent maturity progression and track execution episodes.
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/graduation/agents/{id}/readiness | Calculate readiness score |
| POST | /api/graduation/agents/{id}/exam | Trigger graduation exam |
| GET | /api/graduation/agents/{id}/episodes | Get episode history |
| POST | /api/graduation/agents/{id}/promote | Promote agent (admin) |
| POST | /api/graduation/agents/{id}/demote | Demote agent (admin) |
| GET | /api/graduation/agents/{id}/history | Promotion history |
| GET | /api/graduation/edge-cases | List edge cases |
| POST | /api/graduation/edge-cases | Create edge case |
| POST | /api/graduation/episodes/{id}/feedback | Submit episode feedback (RLHF) |
| GET | /api/graduation/episodes/{id}/feedback | Get episode feedback |
**Full Graduation API Documentation →**
---
Canvas & Marketplace
Create, install, and manage canvas components and skills.
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/canvas-skills/create | Create component + skill |
| POST | /api/canvas-skills/install | Install component |
| POST | /api/canvas-skills/marketplace/permission | Grant marketplace permission |
| POST | /api/canvas-skills/marketplace/submit | Submit to marketplace |
| GET | /api/canvas-marketplace/components | Browse marketplace |
| GET | /api/canvas-marketplace/components/{id} | Get component details |
| POST | /api/canvas-marketplace/components/publish | Publish component |
| POST | /api/canvas-marketplace/components/install | Install component |
| POST | /api/canvas-marketplace/components/{id}/rate | Rate component |
**Full Marketplace API Documentation →**
---
Integrations
Manage third-party service integrations.
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/integrations | List all integrations |
| GET | /api/integrations/{provider} | Get integration status |
| POST | /api/integrations/{provider}/connect | Connect integration |
| POST | /api/integrations/{provider}/disconnect | Disconnect integration |
| GET | /api/integrations/{provider}/status | Check connection status |
| POST | /api/integrations/{provider}/test | Test integration |
**Full Integration API Documentation →**
---
Chat & Sessions
Real-time agent conversations.
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/sessions | List all sessions |
| POST | /api/sessions | Create new session |
| GET | /api/sessions/{id} | Get session details |
| DELETE | /api/sessions/{id} | Delete session |
| POST | /api/chat | Send chat message |
| GET | /api/chat/stream | Stream chat responses (SSE) |
---
MCP (Model Context Protocol)
Interoperability with external tools.
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/mcp | MCP server endpoint (SSE) |
| POST | /api/mcp/tools | List available tools |
| POST | /api/mcp/execute | Execute MCP tool |
---
Desktop App
Desktop-specific commands (Tauri).
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/desktop/actions | Execute desktop action |
| GET | /api/desktop/status | Get desktop status |
| POST | /api/desktop/terminal | Execute terminal command |
| POST | /api/desktop/docker | Manage Docker containers |
---
Common Request Patterns
Pagination
List endpoints support pagination:
GET /api/agents?page=1&limit=20**Response:**
{
"data": [...],
"pagination": {
"page": 1,
"limit": 20,
"total": 150,
"pages": 8
}
}Filtering
Filter results with query parameters:
GET /api/agents?maturity_level=student&status=activeSorting
Sort results:
GET /api/agents?sort=created_at&order=descSearch
Search across text fields:
GET /api/agents?q=assistant---
Error Codes
| Code | Status | Description |
|---|---|---|
UNAUTHORIZED | 401 | Invalid or missing authentication |
FORBIDDEN | 403 | Insufficient permissions |
NOT_FOUND | 404 | Resource not found |
RATE_LIMIT_EXCEEDED | 429 | Rate limit exceeded |
AGENT_NOT_FOUND | 404 | Agent does not exist |
AGENT_LIMIT_EXCEEDED | 403 | Tenant agent limit reached |
GOVERNANCE_VIOLATION | 403 | Action not allowed by governance |
INVALID_INPUT | 400 | Request validation failed |
INTERNAL_ERROR | 500 | Server error |
---
SDKs
Official SDKs for popular languages:
TypeScript/JavaScript
npm install @atom/sdkimport { AtomClient } from '@atom/sdk';
const client = new AtomClient({
apiKey: process.env.ATOM_API_KEY
});
const agents = await client.agents.list();
const agent = await client.agents.create({
name: 'My Agent',
role: 'general-assistant'
});Python
pip install atom-python-sdkfrom atom import AtomClient
client = AtomClient(api_key="your_api_key")
agents = client.agents.list()
agent = client.agents.create(
name="My Agent",
role="general-assistant"
)---
Webhooks
Receive real-time notifications:
Configure Webhook
POST /api/webhooks
{
"url": "https://your-app.com/webhooks/atom",
"events": ["agent.executed", "agent.graduated"],
"secret": "webhook_secret"
}Webhook Events
**agent.executed** - Agent completed task execution
{
"event": "agent.executed",
"data": {
"agent_id": "agent_123",
"execution_id": "exec_456",
"status": "success",
"result": { ... }
},
"timestamp": "2025-02-06T10:00:00Z"
}**agent.graduated** - Agent reached new maturity level
{
"event": "agent.graduated",
"data": {
"agent_id": "agent_123",
"previous_level": "intern",
"new_level": "supervised",
"readiness_score": 0.85
},
"timestamp": "2025-02-06T10:00:00Z"
}---
OpenAPI Specification
Complete OpenAPI 3.0 specification available within your tenant context:
- **Interactive Swagger UI:**
https://[your-tenant].atomagentos.com/api/docs - **JSON Spec:**
https://[your-tenant].atomagentos.com/api/openapi.json - **Redoc:**
https://[your-tenant].atomagentos.com/api/redoc
---
Support
- **Documentation:** https://atomagentos.com/docs
- **Platform Support:** support@atomagentos.com
- **GitHub Issues:** atom-saas/issues
---
**Last Updated:** 2025-02-06
**API Version:** v8.0