Skip to content

API Overview

ZERG exposes 115+ REST endpoints via Cowboy HTTP server. All endpoints accept and return JSON.

Base URL

https://api.nonsense.ws/api/v1

Authentication

Most endpoints require a Bearer token:

bash
curl -H "Authorization: Bearer <token>" https://api.nonsense.ws/api/v1/status

See Authentication for token management.

API Documentation

An interactive Swagger UI is available at /api-docs and the OpenAPI 3.1 spec at /openapi.json.

Endpoint Categories

CategoryPrefixDescription
Inference/api/v1/inference/Start/stop LLM inference instances
Completions/api/v1/chat/completionsOpenAI-compatible chat completions
Messages/api/v1/messagesAnthropic-compatible messages API
Workers/api/v1/workers/Agent worker management
Workflows/api/v1/workflows/Multi-step agent workflows
Memory/api/v1/memory/Vector memory store and retrieval
Conversations/api/v1/conversations/Session management
Workspace/api/v1/workspace/File operations (read/write/edit/search/list)
Scheduler/api/v1/schedules/Cron/at/every job scheduling
Events/api/v1/events/SSE event streaming
Health/health, /readyHealth and readiness checks
SLO/api/v1/sloSLO metrics and compliance
Infra/api/v1/infra/Maintenance mode, service status
Goals/api/v1/goals/Goal tracking and management
Auth/api/v1/auth/OAuth proxy (login/validate/refresh/logout)

Common Response Format

json
{
  "ok": true,
  "data": { ... }
}

Error responses:

json
{
  "error": "description of the error"
}

Released under the MIT License.