Welcome to the Vimond Developer Hub!
At Vimond, we believe in the power of innovation and collaboration. Our Developer Hub is a dedicated space designed to empower developers like you to unlock the full potential of our APIs and services.
Whether you’re a seasoned developer or just starting, this hub is your gateway to explore, integrate, and create transformative media solutions. Here, you’ll find comprehensive documentation, helpful resources, and best practices to guide you through every step of the development process.
The content is organized into Guides and Tutorials, which you can navigate through the menu on the left. OpenAPI specifications power the interactive API reference (Scalar): contracts for HTTP endpoints, with compact indexes for AI agents under For AI agents in the sidebar.
How this hub relates to the CMS user guide
Section titled “How this hub relates to the CMS user guide”VIA is often described in two parts:
- Workflow (CMS / back office) — Editorial teams use the VIA web application for catalogs, ingest, products, campaigns, and day-to-day operations. For product usage in the browser (click paths, screens, and configuration tasks), use the VIA user guide.
- Experience (end-user services) — Developers integrate the APIs and services that power viewers’ apps and sites: identity, playback, discovery, device registration, and more. This Developer Hub is the home for those integration guides and the API reference.
In the sidebar, Content management covers APIs for ingest, metadata, curation, and monetization—often the same areas you configure in the CMS first. Viewer-facing covers the services consumed by client applications. Some guides link to the user guide when a UI step complements an API workflow.
API reference surfaces
Section titled “API reference surfaces”Use the guide that matches your integration; open the matching OpenAPI reference for request/response schemas.
| You are building… | Start with | OpenAPI reference |
|---|---|---|
| Back-office catalog, publishing, products, orders (legacy REST) | Getting started with VIA APIs | Vimond REST API — vimond-rest-api.llms.md |
| 2.0 platform management (assets, users) | Same + tenant docs | Management API |
| End-user catalog (assets, categories, lists, EPG) | Content discovery | Content Discovery API |
| Stream URLs and playback | Video playback | Play Service API |
| Image URLs and image-pack admin | Image service | Image Service API |
AI agents: Integration skill, llms.txt, and per-service compact indexes in the sidebar under For AI agents.
Before exploring the API guides and references, we highly recommend reading the Getting started with VIA APIs and Terminology and Concepts sections, which provide essential background information. Additionally, the Frequently Asked Questions section addresses common queries you may have.
If you encounter any issues or have questions along the way, our dedicated Vimond Support team is here to assist you. Don’t hesitate to reach out to us!
In the API reference, each Scalar page documents one OpenAPI spec. Expand an operation’s response section for the schema returned for each status code.
Let’s Build Together!
At Vimond, we are committed to supporting your development journey every step of the way. We are excited to see what you’ll create with our APIs and services. So, let’s build innovative media experiences together and transform the world of content delivery!
Happy coding!