Skip to content

API endpoints ​

The default API prefix is /api; every public prefix is configurable. The live server exposes the authoritative OpenAPI 3.1 document at its configured OpenAPI route.

Authentication ​

Use a bearer API key for integrations:

http
Authorization: Bearer gfs_…

The browser UI uses a session cookie. State-changing cookie-authenticated calls also send the configured CSRF header.

Endpoint summary ​

MethodDefault pathPurpose
GET/health/liveProcess liveness
GET/health/readyDependency readiness
GET/openapi.yamlRuntime-resolved OpenAPI 3.1 document
POST/api/accountsRegister an account
POST/api/auth/loginCreate browser session
GET/api/auth/sessionRead/refresh browser session
POST/api/auth/logoutRevoke browser session
GET/PATCH/api/accountRead/update account
GET/POST/api/account/api-keysList/create API keys
DELETE/api/account/api-keys/{id}Revoke API key
GET/api/dashboardDashboard snapshot
GET/POST/api/mediaList/upload media
POST/api/media/importsQueue remote import
GET/PATCH/DELETE/api/media/{id}Read/update/delete media
POST/api/media/{id}/retryRetry failed processing
GET/api/media/{id}/jobsMedia processing history
POST/api/media/{id}/playback-tokensCreate private watch URL
GET/api/jobsList account jobs
GET/api/analytics/summaryAnalytics totals
GET/api/analytics/time-seriesDaily analytics
POST/api/playback/{session}/eventsPlayer event ingestion
GET/watch/{id}HTML5 player
GET/stream/{id}/master.m3u8HLS master playlist
GET/stream/{id}/sourceOriginal source
GET/stream/{id}/{variant}/{asset}HLS variant assets

For request fields, status codes, schemas, query parameters, and examples, use the OpenAPI document or response examples.

Released under the MIT License.