# API Reference

The backend is a FastAPI application that serves REST APIs, an SSE stream for captions/metadata (via MQTT), and WebSocket endpoints for metrics.

## Interactive API docs

When the stack is running, FastAPI provides OpenAPI/Swagger UI at:

- `http://localhost:4173/docs`

(If you run the backend on a different host/port, adjust accordingly.)

## REST Endpoints

### Models

- `GET /api/vlm-models` — List available VLM models discovered under `ov_models/`
- `GET /api/detection-models` - List available object detection models discovered under `ov_detection_models/`

### Pipelines

- `GET /api/pipelines` — List available pipeline configurations

### Captions & Alerts

- `POST /api/generate_captions_alerts` — Generate captions and alerts for a live stream
- `GET /api/generate_captions_alerts` — List all active caption generation runs
- `GET /api/generate_captions_alerts/{run_id}` — Get details of a specific caption generation run (includes `mqttTopic` field)
- `DELETE /api/generate_captions_alerts/{run_id}` — Stop caption generation for a stream

#### Run Response Schema

```json
{
  "runId": "string",
  "pipelineId": "string",
  "peerId": "string",
  "mqttTopic": "live-video-captioning/{runId}",
  "modelName": "string",
  "pipelineName": "string",
  "runName": "string",
  "prompt": "string",
  "maxTokens": 100,
  "rtspUrl": "string"
}
```

## Streaming Endpoints

### Server-Sent Events (SSE)

- `GET /api/generate_captions_alerts/metadata-stream` — Multiplexed SSE stream for all active runs

The SSE stream provides real-time metadata received from the MQTT broker. Each message is an envelope containing:

```json
{
  "runId": "string",
  "data": { /* pipeline inference result */ },
  "received_at": 1705432800.123
}
```

## Related docs

- [Get Started](./get-started.md)
- [Known Issues](./known-issues.md)