Home/Server/API Reference

API Reference

Complete API surface for Beep.AI.Server

Authentication

All /v1/* routes require Bearer token or API-key authentication. Website/admin routes use session-based auth. See Security for details.

OpenAI-Compatible APIs (/v1/*)

The canonical external API surface. Drop-in compatible with OpenAI SDKs.

MethodEndpointDescription
POST/v1/chat/completionsChat completions with streaming, tool calling, vision support
POST/v1/completionsLegacy text completions
POST/v1/embeddingsGenerate text embeddings
GET/v1/modelsList available models
GET/v1/models/{model_id}Retrieve model details

RAG APIs (/v1/rag/*)

MethodEndpointDescription
POST/v1/rag/querySemantic search across collections
POST/v1/rag/collections/{id}/queryQuery a specific collection
GET/v1/rag/collectionsList all collections
POST/v1/rag/collectionsCreate a new collection
GET/v1/rag/runtime/database-profilesList storage profiles
POST/v1/rag/runtime/database-profilesCreate storage profile

Agent Framework APIs (/v1/agent-framework/*)

MethodEndpointDescription
POST/v1/agent-framework/executeExecute an agent with tools and memory
POST/v1/agent-framework/planGenerate a multi-step plan
GET/v1/agent-framework/telemetryRetrieve agent telemetry

Other /v1/* Endpoints

MethodEndpointDescription
GET/v1/mcp/toolsMCP tool discovery and invocation
POST/v1/audio/transcriptionsSpeech-to-text transcription
POST/v1/audio/speechText-to-speech generation
POST/v1/images/generationsText-to-image generation
POST/v1/document-extractionDocument parsing and extraction
GET/v1/healthHealth check endpoint
POST/v1/toolingTool execution API
GET/v1/scheduler/jobsJob scheduling API
GET/v1/usersUser management API
GET/v1/tokensToken management API

Admin & Website Routes

RouteDescriptionAuth
/admin/Admin dashboardSession
/admin/usersUser CRUD managementSession + Admin
/admin/rolesRole and permission managementSession + Admin
/admin/servicesService status, email, monitoring, auditSession + Admin
/admin/sessionsSession managementSession + Admin
/admin/authOAuth2, LDAP, Azure AD configurationSession + Admin
/admin/mcpMCP server management surfaceSession
/agentsAgent Framework overviewSession
/ragRAG management overviewSession
/studioAgent Studio dashboardSession
/toolingTooling service workspaceSession
/specialty-layersSpecialty Layers serviceSession
/data-sourcesEnterprise data sourcesSession
/workflow-engineWorkflow execution engineSession