# Mediux API

> Read Mediux artwork with no sign-up, or act for a user with OAuth.

Community artwork for shows, movies, collections and games, as JSON.

The Mediux API gives your app the artwork, Sets, creators and Lists in the
Mediux library. Reading public artwork needs no account, key or token: send a
`GET` and you're done. To act for a user, such as editing their Lists, use
OAuth.

- [Get started](https://docs-preview.mediux.io/api/quickstart.md)
- [Browse endpoints](https://docs-preview.mediux.io/api/reference.md)

## Two APIs, one host

Everything lives at `https://api.mediux.io`.

|                | Public API                                    | Protected API                                    |
| -------------- | --------------------------------------------- | ------------------------------------------------ |
| Use it to      | Read titles, Sets, creators, Lists and feeds  | Read and edit one user's Lists, follows and more |
| Authentication | None                                          | OAuth access token the user approved             |
| Methods        | `GET` and `HEAD`                              | `GET`, `POST`, `PATCH`, `PUT` and `DELETE`       |
| Paths          | `/shows/1399`, `/movie-set/{id}`, …           | `/account`, `/notifications`, `/relationships`   |
| Runs from      | Anywhere, including browsers                  | Your server or a native app                      |

Artwork itself comes from `https://img.mediux.io`; responses give you image IDs
and you [build the URLs](https://docs-preview.mediux.io/api/guides/image-urls.md).

## Start here

- [Get started](https://docs-preview.mediux.io/api/quickstart.md): Make your first request in a minute.
- [Authentication](https://docs-preview.mediux.io/api/authentication.md): Register an app and connect a user with OAuth.
- [Responses and errors](https://docs-preview.mediux.io/api/errors.md): The response envelope, IDs and every error code.
- [Indexes, feeds and pages](https://docs-preview.mediux.io/api/pagination.md): List everything of one type and follow new artwork.

## Guides

- [Build image URLs](https://docs-preview.mediux.io/api/guides/image-urls.md): Turn an image ID into a full-size or resized URL.
- [Use Set YAML with Kometa](https://docs-preview.mediux.io/api/guides/kometa.md): Apply a whole Set to your Plex library.
- [Read and edit Lists](https://docs-preview.mediux.io/api/guides/lists.md): Read a user's Lists, and create and fill them.
- [Draw the Ambient Mesh](https://docs-preview.mediux.io/api/guides/ambient-mesh.md): Paint a title's colour wash in plain CSS.
