API Reference
API Overview
NixStream Client API authentication and conventions
The Client API gives you programmatic access to NixStream resources.
Base URL
https://your-domain.com/api/client/v1Authentication
All endpoints require an API key as a Bearer token:
Authorization: Bearer YOUR_API_KEYGenerate keys in Settings > General in the admin panel. Keys are shown once at creation.
Store API keys securely. They are hashed at rest and cannot be retrieved after creation.
Response format
Successful responses return JSON. Paginated endpoints include Laravel pagination metadata (data, links, meta).
Error codes
| Status | Meaning |
|---|---|
| 401 | Missing or invalid API key |
| 404 | Resource not found or not in your tenant |
| 422 | Validation error |
| 500 | Server error |
| 503 | Media server unavailable (live streams) |
Endpoints
| Resource | Endpoints |
|---|---|
| Collections | GET /collections |
| Videos | GET /videos, GET /videos/{id} |
| Uploads | POST /uploads, GET /uploads, GET /uploads/{id} |
| Live Streams | GET /live-streams, GET /live-streams/active, GET /live-streams/{id} |
| Shareable Links | POST /shareable-links |
Tenant isolation
API keys are scoped to a tenant. You only see resources for your tenant.