# Introduction

The mint API lets your own systems (for example a learning platform) read the catalogs, briefing
templates and categories of your company in mint, create categories and order films: `POST /films` creates a film from a
briefing (title, narration text, template or settings); mint can then plan it and produce it automatically up to the
storyboard or the finished film. Read your films with `GET /films` and `GET /films/{id}` and cancel them with
`POST /films/{id}/cancel` until the storyboard is ready. Follow changes in the event feed `GET /events` and download
approved films with `GET /films/{id}/file` (and their subtitles). It is a server-to-server API: browsers on other sites
cannot call it (no CORS).

> **Kurz auf Deutsch.** Mit der mint API binden Sie mint an Ihre eigenen Systeme an, zum Beispiel an eine Lernplattform.
> Sie bestellen Filme aus einem Briefing, verfolgen den Fortschritt, geben Feedback zum Storyboard und laden freigegebene
> Filme herunter. Die Freigabe eines Films bleibt immer bei einer Person in mint. Die Referenz ist auf Englisch, wie die
> API selbst. Der schnellste Einstieg ist der [Quickstart](/api/quickstart); Zugänge und Schlüssel legen Admins Ihrer
> Firma in mint unter *Einstellungen → API-Zugänge* an.

## Base URL

`https://api.cream-ai.de/api/v1`. All paths in this document are relative to it. Requests and responses use JSON (UTF-8) unless an endpoint says otherwise, for example file
downloads and uploads. All times are UTC in ISO 8601.

## How a film flows through the API

1. Read your catalogs once: templates, styles, brands, voices and categories.
2. Order a film with `POST /films`. mint plans and produces it up to the storyboard (or the film).
3. Follow its state with the [event feed](/api/event-feed) or `GET /films/{id}/progress`.
4. Optionally review it: a storyboard preview, feedback on scenes, comments on the finished film.
5. A person approves the film in mint. Then download it with `GET /films/{id}/file`.

```sh Base URL
https://api.cream-ai.de/api/v1
```

```sh Your first request
curl https://api.cream-ai.de/api/v1/me \
  -H "Authorization: Bearer $MINT_API_KEY"
```