You are viewing documentation for an outdated version of the specification.
Overview
The Open Media Streaming Standard (OMSS) defines a standardized HTTP API for media backends. By adhering to the specification, both clients and servers can interoperate without requiring implementation-specific integrations. OMSS specifies:- A consistent HTTP API for resolving media sources
- Standard request and response models
- Common provider behavior
- Metadata and source representations
- A portable contract that any compliant implementation can expose
Core Concepts
Understanding these concepts will help you read the endpoint reference and understand the API.Media IDs
OMSS identifies media using TMDB IDs (The Movie Database identifiers). Movie endpoints require the movie’s TMDB ID. TV episode endpoints require:- TMDB show ID
- Season number
- Episode number
Providers
A provider is an implementation responsible for resolving media sources from a particular streaming source. The OMSS specification defines the contract between the server and its providers, but does not prescribe how providers are implemented, discovered, or managed. Different OMSS implementations may use different architectures/technologies while exposing the same external API. (e.g., you could implement OMSS with TypeScript, Python, or Go, and aslong as the API contract is followed, clients will work with any implementation.)Sources
A source represents a playable or downloadable media stream returned by one or more providers. A source may include information such as:- Stream URL
- Quality
- Language
- Available subtitles
- Provider metadata
Proxying & Stream Resolution
Some providers expose streams through intermediary proxy services rather than direct origin URLs. OMSS standardizes the representation of resolved media sources but intentionally leaves proxying, URL unwrapping, caching strategies, and request routing as implementation details. Individual servers may choose to expose original URLs, proxy endpoints, or additional stream processing features.How to Read This Reference
Generated from the specification
Every endpoint in this section is generated directly from the official OMSS v1.0 OpenAPI specification. The reference stays synchronized with the standard rather than relying on manually maintained documentation.
Interactive playground
Each endpoint includes an interactive playground. Configure the server URL to point at any OMSS-compliant implementation and execute requests directly from the documentation.
Implementation-independent
This reference describes the OMSS specification itself—not any particular implementation. Any server conforming to OMSS should expose the same API contract.
Multi-language examples
Every endpoint includes automatically generated examples for JavaScript, cURL, Python, PHP, Go, and Java.
The playground defaults to
https://api.example.com. Replace the server URL with the address of your own OMSS-compatible server before sending requests.Before You Start
To use this API, you’ll need access to an OMSS-compliant server. Depending on the implementation you choose, additional configuration may be required, such as:- Deploying or connecting to an OMSS server
- Configuring provider integrations
- Supplying any required API keys or credentials
- Enabling one or more providers capable of resolving media sources
Get Movie Sources
Resolve streaming sources for a movie by TMDB ID.
Get TV Episode Sources
Resolve streaming sources for a TV episode using its TMDB show ID, season, and episode.