API reference (OpenAPI)
Interactive API documentation is rendered with Scalar from OpenAPI documents bundled with this site.
- Vimond REST API — backoffice REST service (
/openapi/openapi.yml) - Vimond Management API — management API for assets, users, and related operations (
/openapi/management-api.yaml) - Vimond Image Service API — image retrieval, image pack and location admin, cache invalidation (
/openapi/image-service.yaml). Not part of the Management API in the 2.0 platform — see the image service overview. - Vimond Content Discovery API — viewer-facing search and lookup for published assets, categories, curated lists, EPG, and popular content (
/openapi/content-discovery.yaml). See the content discovery guide. - Vimond Play Service API — stream URLs, DRM hints, subtitles, and player-session event templates for playback (
/openapi/play-service.yaml). See video playback.
If you use “Try it” in the browser against APIs that do not allow your documentation origin in CORS, you may need your API gateway to allow that origin, or a small request proxy. Your Vimond contact can advise for your environment.