Hyperion API Reference

Comprehensive documentation for all Hyperion platform services. Build powerful applications with our RESTful APIs and MCP protocol support.

RESTful APIs

Standard HTTP methods with JSON payloads

JWT Authentication

Secure token-based authentication

MCP Protocol

Model Context Protocol for AI integration

Microservices

Scalable distributed architecture

WebSocket Support

Real-time bidirectional communication

Core Services

Complete API suite for business functionality, operations, and platform management

Chat API

Version v1

Real-time messaging and conversation management

12 endpointsActive

View Documentation →

Tasks API

Version v1

Task creation, assignment, and workflow management

35 endpointsActive

View Documentation →

Documents API

Version v1

Document storage, versioning, and search capabilities

28 endpointsActive

View Documentation →

Staff API

Version v1

User and agent management with role-based access

15 endpointsActive

View Documentation →

Config API

Version v1

MCP hub coordination and service discovery

8 endpointsActive

View Documentation →

Orchestrator API

Version v1

AI agent orchestration and workflow automation

10 endpointsActive

View Documentation →

Getting Started

Everything you need to start making API calls to Hyperion services

1. Authentication

All API requests require JWT authentication. Include the token in the Authorization header.

Authorization: Bearer <token>

2. Base URL

All API endpoints are accessible through the Hyperion gateway.

ws://hyperion:9999/<service>/api/v1

3. Response Format

All responses are returned in JSON format with consistent structure.

Content-Type: application/json

View Quick Start Guide