ODK API Portal
API documentation for ODK Media's services. Pick a service, pick an environment, and try requests right from the docs.
Getting started
-
Pick a service
Find the API that matches your work in the cards below. Each one lists which app uses it and who it's for.
-
Pick an environment
Switch environments from the selector at the top right of the doc. prod is the live service; staging is for checking things before they ship. Staging docs flag where they differ from prod.
-
Try a request
Click Test on any endpoint to open a request panel with headers and parameters already filled in. Click Send and you'll get a real response.
MediaIO
Continue Watching
Player Event
Deprecated
What the badges on a doc mean
- Hand-written specification — maintained by people, not generated from service code. It may differ from actual behavior.
- Deprecated — don't use this for new integrations. Kept for existing integrations.
- Differs from prod / Not in prod yet — where a staging doc has diverged from prod.
Glossary
| Term | Meaning |
|---|---|
| prod | The live environment used by real users |
| staging | An environment for checking things before they ship. A service can have more than one |
Service-Name | v4 request header. amasian or lg-channel-vietnam. Selects which service's content you get |
did | Device ID header. Needed for per-device responses like favorites and continue watching |
| Previous / Deprecated | A newer version exists / kept only so existing integrations keep working |
Most specs on this portal are collected automatically from service code. If something looks wrong, the fix belongs in that service's code (extend_schema). A few specs, however, are hand-written documents carried over from odx-api-docs, and are marked with a badge until they move to code generation.
- Snapshots and change history: github.com/odkmedia/api-portal/tree/main/snapshots
- Report an issue: #backend-api