Docs / Self-hosted media platform / v1

Aegis API Documentation

This page documents the real Aegis backend API and integration flow for upload, processing, protected playback, WebRTC calls, recordings ingest, and AI jobs.

API Base

Tenant

Auth Mode

The endpoint list in this page is loaded from /openapi.json at runtime.

Bearer Authentication

All control-plane endpoints use Authorization: Bearer <token>. For project or user-level access, issue API tokens via auth endpoints and send them from backend integrations.

Header	Value	Scope
Authorization	Bearer <token>	API endpoints under /api/v1
X-Device-Fingerprint	Optional client fingerprint	Playback policy checks

Login sessions and devices

For profile security screens you can query real auth login devices by IP and country code, then revoke suspicious sessions.

bash

Quickstart

1) Check token flow

bash

2) Register asset upload

bash

3) Create playback session

bash

Embedding and Player Integration

Recommended flow: create playback session on your backend, return short-lived manifest URL to frontend, initialize player.

Backend session flow

http

Frontend embed

html

Never expose source originals or static public MP4 links. Deliver only manifest + segments via playback gateway.

Realtime Calls, Recording, AI Pipeline

Realtime uses REST for call lifecycle plus WebSocket signaling. When recording is enabled by policy, call media is ingested into assets/jobs pipeline and can trigger ASR/moderation/summary Celery jobs.

http / ws

OpenAPI Endpoint Reference

Updated: -

FAQ

How to switch API environment?

Use API Config in the top bar. Settings are saved in local storage and query params.

Can we use this for audio-only podcasts?

Yes. Audio assets are supported with processing jobs and protected playback sessions, same auth model as video.

How to inspect exact schema for any endpoint?

Open /openapi.json directly or use generated cards above with request/response schema hints.