Skip to content
brūhi Docs

REST API

The brūhi engine exposes a RESTful API on port 8080 by default.

Base URL

Section titled “Base URL”
http://localhost:8080/api/v1

Authentication

Section titled “Authentication”

For managed SaaS deployments, include your API key:

Authorization: Bearer YOUR_API_KEY

Self-hosted deployments can optionally enable auth via config.toml.

Endpoints

Section titled “Endpoints”

Health Check

Section titled “Health Check”
GET /health

Response:

{
  "status": "healthy",
  "version": "2.1.0",
  "uptime": "4h 23m"
}

Pipelines

Section titled “Pipelines”

List Pipelines

Section titled “List Pipelines”
GET /api/v1/pipelines

Create Pipeline

Section titled “Create Pipeline”
POST /api/v1/pipelines
Content-Type: application/json


{
  "name": "studio-a",
  "input": {
    "type": "srt",
    "port": 9000,
    "latency": 120
  },
  "processing": [
    { "plugin": "loudness-normalize", "target": -14 },
    { "plugin": "eq", "bands": [{"freq": 100, "gain": -3}] }
  ],
  "output": {
    "type": "rtp",
    "host": "239.0.0.1",
    "port": 5004
  }
}

Response 201 Created:

{
  "id": "pl_8f3k2j",
  "name": "studio-a",
  "status": "active",
  "created_at": "2026-04-18T12:00:00Z"
}

Delete Pipeline

Section titled “Delete Pipeline”
DELETE /api/v1/pipelines/:id

Metrics

Section titled “Metrics”
GET /api/v1/metrics

Returns Prometheus-compatible metrics for CPU, memory, buffer utilization, and per-pipeline audio levels.