Endpoint reference
Find public routes, response fields, and examples.
Base URL: https://api.mediux.io. All routes support anonymous GET and HEAD.
Use paths without a version prefix, trailing slash, or query parameters.
Entity families
Section titled “Entity families”| Family | Index | Detail and example |
|---|---|---|
| Shows | /shows |
/shows/{id} |
| Seasons | /seasons |
/seasons/{id} |
| Episodes | /episodes |
/episodes/{id} |
| Movies | /movies |
/movies/{id} |
| Collections | /collections |
/collections/{id} |
| People | /people |
/people/{id} |
| Networks | /networks |
/networks/{id} |
| Companies | /companies |
/companies/{id} |
| Categories | /categories |
/categories/{id} |
| Games | /games |
/games/{id} |
Each family also supports /{family}/{id}/sets and
/{family}/pages/{page}. Follow meta.nextPage for later index pages.
Entities appear only while they have eligible active artwork; Base Art alone
does not qualify.
| Set family | Route and example |
|---|---|
| Show | /show-set/{id} |
| Movie | /movie-set/{id} |
| Collection | /collection-set/{id} |
| Game | /game-set/{id} |
| Talent | /talent-set/{id} |
| Brand | /brand-set/{id} |
| Category | /category-set/{id} |
Set responses include public metadata and active member Assets. Use the Set’s
family in the path; there is no generic /sets/{id} route.
YAML exports
Section titled “YAML exports”| Route and example |
|---|
/show-set/{id}.yaml |
/movie-set/{id}.yaml |
/collection-set/{id}.yaml |
These return YAML text. See using YAML for Kometa setup.
Boxsets and Loadouts
Section titled “Boxsets and Loadouts”| Route and example | Contents |
|---|---|
/boxsets/{id} |
Boxset artwork and child Set summaries |
/loadouts/{id} |
Loadout artwork and child Game Set summaries |
Activity feeds
Section titled “Activity feeds”| Route and example | Contents |
|---|---|
/feeds/sets |
Set additions and updates |
/feeds/assets |
Asset additions and replacements |
Follow meta.nextPage for more entries. See pagination
for snapshot expiry and recovery.
Assets and images
Section titled “Assets and images”Read Assets through Entity or Set responses. There is no top-level Asset route,
and Base Art is excluded. Use metadataImages URLs directly. An Asset’s path
is a filename beginning with /; build its original image URL like this:
const imageUrl = new URL( `/assets/originals${asset.path}`, "https://img.mediux.io",);IDs and missing resources
Section titled “IDs and missing resources”Numeric IDs are positive JavaScript-safe integers without signs, leading
zeroes, decimals, or exponents. Unknown resources return 404.
For uploads and other authenticated actions, use personal operations.