Appearance
API Endpoints Übersicht
Die MaxiCore API ist RESTful mit WebSocket-Unterstützung für Echtzeit-Events. Base URL: https://api.maxicore.ch/v2
Authentifizierung
Alle Endpoints erfordern einen Authorization Header:
Authorization: Bearer <JWT_TOKEN>Tokens werden erhalten via Clerk OAuth oder Device-Pairing. Details: Authentication Guide
Endpoints Übersicht
Agents
| Methode | Endpoint | Beschreibung |
|---|---|---|
GET | /agents | Alle deine Agents auflisten |
POST | /agents | Neuen Agent erstellen |
GET | /agents/{id} | Agent-Details abrufen |
PUT | /agents/{id} | Agent konfigurieren |
DELETE | /agents/{id} | Agent löschen |
POST | /agents/{id}/soul | Soul-Dokument aktualisieren |
GET | /agents/{id}/shield | Shield-Policies abrufen |
PUT | /agents/{id}/shield | Shield aktualisieren |
Tasks
| Methode | Endpoint | Beschreibung |
|---|---|---|
GET | /tasks | Alle Tasks auflisten (gefiltert) |
POST | /tasks | Neue Task erstellen |
GET | /tasks/{id} | Task-Details |
PUT | /tasks/{id} | Task aktualisieren |
DELETE | /tasks/{id} | Task abbrechen |
GET | /tasks/{id}/logs | Task-Logs abrufen |
POST | /tasks/{id}/pause | Task pausieren |
POST | /tasks/{id}/resume | Task fortsetzen |
Workspaces
| Methode | Endpoint | Beschreibung |
|---|---|---|
GET | /workspaces | Alle deine Workspaces |
POST | /workspaces | Workspace erstellen |
GET | /workspaces/{id} | Workspace-Info |
PUT | /workspaces/{id} | Workspace aktualisieren |
POST | /workspaces/{id}/invite | Benutzer einladen |
Events (WebSocket)
| Event | Beschreibung |
|---|---|
task.started | Task begonnen |
task.progress | Task Fortschritt (Steps) |
task.completed | Task abgeschlossen |
task.failed | Task Fehler |
agent.online | Agent verbunden |
agent.offline | Agent getrennt |
shield.violation | Shield-Regel verletzt |
WebSocket Endpoint: wss://api.maxicore.ch/v2/ws
Monitoring & Billing
| Methode | Endpoint | Beschreibung |
|---|---|---|
GET | /credits | Aktuelles Credit-Limit |
GET | /credits/usage | Credit-Verbrauch (diesen Monat) |
GET | /billing/invoices | Rechnungshistorie |
GET | /logs | Audit Logs |
Response Format
Alle Responses sind JSON:
json
{
"success": true,
"data": { /* payload */ },
"error": null,
"timestamp": "2026-03-27T10:00:00Z"
}Error Response:
json
{
"success": false,
"data": null,
"error": {
"code": "INVALID_SHIELD_POLICY",
"message": "Shield policy validation failed",
"details": { /* error details */ }
}
}Pagination
List-Endpoints unterstützen Pagination:
bash
GET /tasks?limit=50&offset=100Response enthält:
json
{
"items": [...],
"total": 243,
"limit": 50,
"offset": 100,
"has_more": true
}Rate Limiting
- Free: 100 req/hour
- Standard: 1000 req/hour
- Platinum: 10000 req/hour
- Enterprise: Unlimitiert
Headers in Response:
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 987
X-RateLimit-Reset: 1643923200Weitere Docs
Für komplette API-Referenz: https://api.maxicore.ch/docs