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 Admin Search API — admin search for assets, categories, and content panels (
/openapi/vimond-admin-search.json) - Vimond Management API — back-office 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 — 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. - Vimond Default Payment Provider API — Stripe and Vipps checkout, webhooks, customer and agreement lifecycle (
/openapi/default-payment-provider.yaml). Use Scalar tag sections (e.g. Stripe Checkout, Vipps) or per-tag slices under/openapi/default-payment-provider/tags/. See payment. - VIA Orchestrate Status API — ingest job status and cancellation for the VOD orchestrator (
/openapi/via-orchestrate-status-api.yaml). See ingest status guide. - Vimond Asset Importer Service API — feed ingest: media feeds, push/pull import, jobs, tasks, retry/abort (
/openapi/asset-importer.yaml). See feed ingest guide.
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.