# Vimond Developer Hub

> Official integration documentation for **Vimond VIA**: REST APIs, viewer-facing services, content workflows, and batch data exports for building OTT/streaming clients and platform integrations.

This site is intended for **software developers** integrating with Vimond APIs. Guides explain concepts and workflows; the API reference documents HTTP endpoints from **OpenAPI** specifications.

Canonical site: https://developer.vimond.com/

## For AI agents

- [Integration skill](https://developer.vimond.com/skill.md): **Recommended cheat sheet** — which API to use, auth, JSON v3, Image Service split, terminology traps, and links to compact indexes.
- This file ([llms.txt](https://developer.vimond.com/llms.txt)): discovery manifest and retrieval ladder for all APIs.

## Getting started

- [Introduction](https://developer.vimond.com/docs/introduction/): Overview of the hub and how content is organized.
- [Getting started with VIA APIs](https://developer.vimond.com/docs/getting-started-with-via-apis/): Practical entry point for API usage.
- [Terminology and concepts](https://developer.vimond.com/docs/terminology-and-concepts/): Domain vocabulary used across the docs.

## Guides by area

Use the site sidebar for the full tree. Major areas include:

- **Content management** — ingest, curation, publishing, admin search, payment flows tied to the platform APIs.
- **Viewer-facing services** — authentication, playback, content discovery, DRM, playlists, devices, images, subscriptions, and related client-facing APIs.
- **VIA data** — batch exports and event-stream concepts for analytics and operations.

## Content Discovery (viewer-facing catalog)

Published **assets**, **categories**, **curated lists**, **EPG**, and **popular** rankings for end-user apps. Only published content is returned (404 often means not published).

- [Content discovery overview](https://developer.vimond.com/docs/content-discovery/): Lookups, caching, list depth, EPG.
- [Search APIs](https://developer.vimond.com/docs/search-apis/): Vimond query DSL, examples, limitations.
- OpenAPI: [compact index](https://developer.vimond.com/openapi/content-discovery.llms.md) → [Scalar reference](https://developer.vimond.com/reference/content-discovery/). Raw YAML: `https://developer.vimond.com/openapi/content-discovery.yaml`.

## Video playback (Play Service)

End-user **play** calls return signed stream URLs after entitlement and geo checks. Pair with Content Discovery for asset ids and Player Session for analytics events.

- [Video playback overview](https://developer.vimond.com/docs/video-playback/)
- [Play service API guide](https://developer.vimond.com/docs/video-playback-1-1/)
- OpenAPI: [compact index](https://developer.vimond.com/openapi/play-service.llms.md) → [Scalar reference](https://developer.vimond.com/reference/play-service/). Raw YAML: `https://developer.vimond.com/openapi/play-service.yaml`.

## Image Service (two-part: management + serving)

The Vimond Image Service is split into an **admin** side (image pack and location config CRUD; legacy JVM service) and a **serving** side (CloudFront + Lambda image handler). The same client URL works against both.

- [Image service overview](https://developer.vimond.com/docs/image-service/): Architecture, request flow, and the relationship between the two parts.
- [Image URLs and parameters](https://developer.vimond.com/docs/image-urls-and-parameters/): Client-facing reference for `GET /api/v2/img/<imagePackId>` — every query parameter, format negotiation, access keys, and cache busting.
- [Content Images](https://developer.vimond.com/docs/content-images/): End-to-end tutorial showing how to go from Content Discovery payload to a rendered image URL.
- [Image management](https://developer.vimond.com/docs/image-management/): Admin overview — auth, typical flows, how changes propagate to the serving layer.
- [Image location configs](https://developer.vimond.com/docs/image-location-configs/): Tenant-wide named locations (`main`, `thumb`, `portal-cover`, …), sizes, resize policy.
- [Image packs](https://developer.vimond.com/docs/image-packs/): Lifecycle — create, upload originals, fetch by URL, per-location crop info, bind to assets.
- [Image cache invalidation](https://developer.vimond.com/docs/image-cache-invalidation/): Automatic invalidation pipeline (DynamoDB stream → 5-min aggregator → CloudFront + S3) and the manual `DELETE` endpoint.
- OpenAPI: start with [compact index](https://developer.vimond.com/openapi/image-service.llms.md), then per-tag slice or [Scalar reference](https://developer.vimond.com/reference/image-service/). Raw YAML: `https://developer.vimond.com/openapi/image-service.yaml`.

## API reference (OpenAPI)

Three-tier strategy for agents on the Vimond REST API:

1. **Compact index** (~55 KB Markdown) — find the right operation and its `operationId`, tag, auth, and one-line summary.
2. **Per-tag slice** (~10–150 KB OpenAPI YAML) — load the self-contained slice for the matching tag to see full request/response schemas for that domain.
3. **Canonical spec** (~960 KB OpenAPI YAML) — load only when you need schemas across multiple tags in one document.

- [Vimond REST API — compact index for LLMs](https://developer.vimond.com/openapi/vimond-rest-api.llms.md): **Recommended first stop.** Markdown index of all operations, tags, auth scopes, and the domain glossary. Generated from `openapi.yml`.
- Per-tag OpenAPI slices: `https://developer.vimond.com/openapi/tags/<slug>.openapi.yml` — one self-contained spec per tag (e.g. `assets.openapi.yml`, `products.openapi.yml`). Each slice carries only that tag's operations and the components they reference. The compact index links to the slug for every tag.
- [Vimond REST API (raw OpenAPI)](https://developer.vimond.com/openapi/openapi.yml): Machine-readable **YAML** — ~960 KB; load only when you need everything in one document.
- [Vimond REST API (Scalar)](https://developer.vimond.com/reference/vimond-rest-api/): Interactive HTML reference for humans.
- [Vimond Management API (raw OpenAPI)](https://developer.vimond.com/openapi/management-api.yaml): Machine-readable **YAML** for the Management API.
- [Vimond Management API (Scalar)](https://developer.vimond.com/reference/management-api/): Interactive HTML reference for the Management API.
- [Vimond Image Service API — compact index for LLMs](https://developer.vimond.com/openapi/image-service.llms.md): **Recommended first stop** for image-service operations (~15 KB). Not part of the Management API in 2.0.
- Per-tag Image Service slices: `https://developer.vimond.com/openapi/image-service/tags/<slug>.openapi.yml` — one self-contained spec per tag (e.g. `image-retrieval.openapi.yml`, `image-packs-admin.openapi.yml`).
- [Vimond Image Service API (raw OpenAPI)](https://developer.vimond.com/openapi/image-service.yaml): Machine-readable **YAML** for the Image Service (~40 KB). Covers end-user image retrieval, admin (image packs, locations, uploads, cropping, regions), and cache invalidation. **Not part of the Management API** in the 2.0 platform — it has its own spec.
- [Vimond Image Service API (Scalar)](https://developer.vimond.com/reference/image-service/): Interactive HTML reference for the Image Service.
- [Vimond Content Discovery API — compact index for LLMs](https://developer.vimond.com/openapi/content-discovery.llms.md): **Recommended first stop** for viewer-facing catalog search and lookup (~5 KB). Hub-maintained; covers assets, categories, curated lists, EPG, popular.
- Per-tag Content Discovery slices: `https://developer.vimond.com/openapi/content-discovery/tags/<slug>.openapi.yml` — e.g. `assets.openapi.yml`, `curated-lists.openapi.yml`.
- [Vimond Content Discovery API (raw OpenAPI)](https://developer.vimond.com/openapi/content-discovery.yaml): Machine-readable **YAML** for Content Discovery.
- [Vimond Content Discovery API (Scalar)](https://developer.vimond.com/reference/content-discovery/): Interactive HTML reference for Content Discovery.
- [Vimond Play Service API — compact index for LLMs](https://developer.vimond.com/openapi/play-service.llms.md): Stream URL playout (v2 `POST …/play`).
- Per-tag Play Service slices: `https://developer.vimond.com/openapi/play-service/tags/<slug>.openapi.yml`
- [Vimond Play Service API (raw OpenAPI)](https://developer.vimond.com/openapi/play-service.yaml)
- [Vimond Play Service API (Scalar)](https://developer.vimond.com/reference/play-service/)
- [API reference home](https://developer.vimond.com/reference/): Reference landing page.

## Markdown mirrors (text-first, smaller than HTML)

For each guide page, the production build emits a **`.md` file** next to the HTML route so tools can fetch plain Markdown (smaller context than rendered HTML). Same path as the HTML page, with **`.md`** instead of a trailing slash or `index.html`:

- Guide (HTML): `https://developer.vimond.com/docs/introduction/`
- Same guide as Markdown: `https://developer.vimond.com/docs/introduction.md`

The home page mirror is [`/index.md`](https://developer.vimond.com/index.md). Mirrors include a short YAML frontmatter (`title`, optional `description`) and a brief HTML comment with the canonical URL; body content matches the source Markdown guides.

## Discovery for tools and crawlers

- [Sitemap](https://developer.vimond.com/sitemap-index.xml): All indexable HTML URLs from the static build.

## Optional (broader context)

- Individual guide pages use stable URLs of the form `https://developer.vimond.com/docs/<slug>/`, where `<slug>` matches the legacy Readme.io document slug when applicable.