# mint API Reference

> 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 an

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

## Getting started

- [Introduction](https://docs.cream-ai.de/api/index.md)
- [Quickstart](https://docs.cream-ai.de/api/quickstart.md)
- [Authentication](https://docs.cream-ai.de/api/authentication.md)
- [Scopes](https://docs.cream-ai.de/api/scopes.md)
- [Errors](https://docs.cream-ai.de/api/errors.md)
- [Idempotent requests](https://docs.cream-ai.de/api/idempotent-requests.md)
- [Film versions](https://docs.cream-ai.de/api/film-versions.md)
- [Pagination](https://docs.cream-ai.de/api/pagination.md)
- [Event feed](https://docs.cream-ai.de/api/event-feed.md)
- [Downloads](https://docs.cream-ai.de/api/downloads.md)
- [Long-running operations](https://docs.cream-ai.de/api/long-running-operations.md)
- [Limits](https://docs.cream-ai.de/api/rate-limits.md)
- [Compatibility](https://docs.cream-ai.de/api/versioning.md)

## Account

- [Account](https://docs.cream-ai.de/api/account.md)
- [The API access object](https://docs.cream-ai.de/api/account/object.md)
- [Show the API access of this key](https://docs.cream-ai.de/api/account/retrieve.md): `GET /me`
- [This API description (OpenAPI 3.1)](https://docs.cream-ai.de/api/account/openapi.md): `GET /openapi.json`

## Films

- [Films](https://docs.cream-ai.de/api/films.md)
- [The film object](https://docs.cream-ai.de/api/films/object.md)
- [Create a film from a briefing](https://docs.cream-ai.de/api/films/create.md): `POST /films`
- [Get a film](https://docs.cream-ai.de/api/films/retrieve.md): `GET /films/{id}`
- [List films](https://docs.cream-ai.de/api/films/list.md): `GET /films`
- [Cancel a film](https://docs.cream-ai.de/api/films/cancel.md): `POST /films/{id}/cancel`
- [Download the approved film file](https://docs.cream-ai.de/api/films/download.md): `GET /films/{id}/file`
- [Download the subtitles of the approval](https://docs.cream-ai.de/api/films/subtitles.md): `GET /films/{id}/subtitles.srt`

## Film progress

- [Film progress](https://docs.cream-ai.de/api/film-progress.md)
- [The film progress object](https://docs.cream-ai.de/api/film-progress/object.md)
- [Get the production progress of a film](https://docs.cream-ai.de/api/film-progress/retrieve.md): `GET /films/{id}/progress`

## Events

- [Events](https://docs.cream-ai.de/api/events.md)
- [The event object](https://docs.cream-ai.de/api/events/object.md)
- [Read the event feed](https://docs.cream-ai.de/api/events/list.md): `GET /events`

## Storyboard previews

- [Storyboard previews](https://docs.cream-ai.de/api/storyboard-previews.md)
- [The storyboard preview object](https://docs.cream-ai.de/api/storyboard-previews/object.md)
- [Request a storyboard preview (costs credits)](https://docs.cream-ai.de/api/storyboard-previews/create.md): `POST /films/{id}/storyboard-preview`
- [Get a storyboard preview](https://docs.cream-ai.de/api/storyboard-previews/retrieve.md): `GET /films/{id}/storyboard-preview`
- [Download the MP4 of a storyboard preview](https://docs.cream-ai.de/api/storyboard-previews/download.md): `GET /films/{id}/storyboard-preview/file`

## Feedback

- [Feedback](https://docs.cream-ai.de/api/feedback.md)
- [The feedback object](https://docs.cream-ai.de/api/feedback/object.md)
- [Send feedback on scenes of the storyboard](https://docs.cream-ai.de/api/feedback/create.md): `POST /films/{id}/feedback`
- [Get a feedback entry](https://docs.cream-ai.de/api/feedback/retrieve.md): `GET /films/{id}/feedback/{feedback_id}`
- [List the feedback entries of a film](https://docs.cream-ai.de/api/feedback/list.md): `GET /films/{id}/feedback`
- [Cancel a feedback entry](https://docs.cream-ai.de/api/feedback/cancel.md): `POST /films/{id}/feedback/{feedback_id}/cancel`
- [Retry a failed feedback entry](https://docs.cream-ai.de/api/feedback/retry.md): `POST /films/{id}/feedback/{feedback_id}/retry`

## Comments

- [Comments](https://docs.cream-ai.de/api/comments.md)
- [The comment object](https://docs.cream-ai.de/api/comments/object.md)
- [Comment on a film](https://docs.cream-ai.de/api/comments/create.md): `POST /films/{id}/comments`
- [List the comments on a film](https://docs.cream-ai.de/api/comments/list.md): `GET /films/{id}/comments`
- [Apply the comments (new revision)](https://docs.cream-ai.de/api/comments/apply.md): `POST /films/{id}/comments/apply`

## Uploads

- [Uploads](https://docs.cream-ai.de/api/uploads.md)
- [The upload object](https://docs.cream-ai.de/api/uploads/object.md)
- [Upload a file](https://docs.cream-ai.de/api/uploads/create.md): `POST /uploads`
- [Get an upload](https://docs.cream-ai.de/api/uploads/retrieve.md): `GET /uploads/{id}`

## Operations

- [Operations](https://docs.cream-ai.de/api/operations.md)
- [The operation object](https://docs.cream-ai.de/api/operations/object.md)
- [Get an operation](https://docs.cream-ai.de/api/operations/retrieve.md): `GET /operations/{id}`

## Categories

- [Categories](https://docs.cream-ai.de/api/categories.md)
- [The category object](https://docs.cream-ai.de/api/categories/object.md)
- [List the category tree](https://docs.cream-ai.de/api/categories/list.md): `GET /categories`
- [Create a category or subcategory](https://docs.cream-ai.de/api/categories/create.md): `POST /categories`
- [Rename a category or change its external key](https://docs.cream-ai.de/api/categories/update.md): `PATCH /categories/{id}`

## Templates

- [Templates](https://docs.cream-ai.de/api/templates.md)
- [The template object](https://docs.cream-ai.de/api/templates/object.md)
- [List briefing templates](https://docs.cream-ai.de/api/templates/list.md): `GET /templates`

## Styles

- [Styles](https://docs.cream-ai.de/api/styles.md)
- [The style object](https://docs.cream-ai.de/api/styles/object.md)
- [List approved styles](https://docs.cream-ai.de/api/styles/list.md): `GET /styles`

## Brands

- [Brands](https://docs.cream-ai.de/api/brands.md)
- [The brand object](https://docs.cream-ai.de/api/brands/object.md)
- [List brands](https://docs.cream-ai.de/api/brands/list.md): `GET /brands`

## Voices

- [Voices](https://docs.cream-ai.de/api/voices.md)
- [The voice object](https://docs.cream-ai.de/api/voices/object.md)
- [List voices](https://docs.cream-ai.de/api/voices/list.md): `GET /voices`

Support: jacques@creamai.de

## Optional

- [Full reference in one file](https://docs.cream-ai.de/llms-full.txt)
- [OpenAPI 3.1 contract](https://docs.cream-ai.de/api/_static/mint-api-v1.openapi.json)