---
title: "API reference"
url: https://lumean.app/en/developers/docs/api
locale: en
description: "Every operation of the public API. Each row has its own page and its own `.md` twin."
generated: 2026-10-17
spec_version: 0.0.1
---

# API reference

Every operation of the public API. Each row has its own page and its own `.md` twin.

Base URL: `https://api.lumean.app/api/public` · required scope: `X-API-KEY`

## Orders

| Operation | Title | Page |
| --- | --- | --- |
| `GET /orders` | List Orders | [get-orders](https://lumean.app/en/developers/docs/md/api/get-orders) |
| `POST /orders` | Create Order | [post-orders](https://lumean.app/en/developers/docs/md/api/post-orders) |
| `POST /orders/chunks/preview` | Preview Chunk Split | [post-orders-chunks-preview](https://lumean.app/en/developers/docs/md/api/post-orders-chunks-preview) |
| `GET /orders/chunks/preview` | Preview Lookup | [get-orders-chunks-preview](https://lumean.app/en/developers/docs/md/api/get-orders-chunks-preview) |
| `GET /orders/chunks/preview/{previewId}` | Preview Page | [get-orders-chunks-preview-preview-id](https://lumean.app/en/developers/docs/md/api/get-orders-chunks-preview-preview-id) |
| `GET /orders/{order}` | Get Order | [get-orders-order](https://lumean.app/en/developers/docs/md/api/get-orders-order) |
| `POST /orders/{order}/cancel` | Cancel Order | [post-orders-order-cancel](https://lumean.app/en/developers/docs/md/api/post-orders-order-cancel) |
| `POST /orders/{order}/retry` | Retry Order | [post-orders-order-retry](https://lumean.app/en/developers/docs/md/api/post-orders-order-retry) |
| `GET /orders/{order}/items` | List Order Items | [get-orders-order-items](https://lumean.app/en/developers/docs/md/api/get-orders-order-items) |
| `GET /orders/{order}/items/{item}` | Get Order Item | [get-orders-order-items-item](https://lumean.app/en/developers/docs/md/api/get-orders-order-items-item) |
| `GET /orders/{order}/items/{item}/text` | Get Order Item Text | [get-orders-order-items-item-text](https://lumean.app/en/developers/docs/md/api/get-orders-order-items-item-text) |
| `POST /orders/{order}/items/retry-failed` | Retry Failed Order Items | [post-orders-order-items-retry-failed](https://lumean.app/en/developers/docs/md/api/post-orders-order-items-retry-failed) |
| `POST /orders/{order}/items/{item}/retry` | Retry Order Item | [post-orders-order-items-item-retry](https://lumean.app/en/developers/docs/md/api/post-orders-order-items-item-retry) |
| `POST /orders/{order}/items/{item}/regenerate` | Regenerate Order Item | [post-orders-order-items-item-regenerate](https://lumean.app/en/developers/docs/md/api/post-orders-order-items-item-regenerate) |

## Storage

| Operation | Title | Page |
| --- | --- | --- |
| `POST /storage/url` | Get File URL | [post-storage-url](https://lumean.app/en/developers/docs/md/api/post-storage-url) |

## Templates

| Operation | Title | Page |
| --- | --- | --- |
| `GET /templates/browse` | Browse Templates | [get-templates-browse](https://lumean.app/en/developers/docs/md/api/get-templates-browse) |
| `GET /templates/config-options` | Get Template Config Options | [get-templates-config-options](https://lumean.app/en/developers/docs/md/api/get-templates-config-options) |
| `GET /templates` | List Templates | [get-templates](https://lumean.app/en/developers/docs/md/api/get-templates) |
| `POST /templates` | Create Template | [post-templates](https://lumean.app/en/developers/docs/md/api/post-templates) |
| `GET /templates/{template}` | Get Template | [get-templates-template](https://lumean.app/en/developers/docs/md/api/get-templates-template) |
| `PUT /templates/{template}` | Update Template | [put-templates-template](https://lumean.app/en/developers/docs/md/api/put-templates-template) |
| `DELETE /templates/{template}` | Delete Template | [delete-templates-template](https://lumean.app/en/developers/docs/md/api/delete-templates-template) |

## Voices

| Operation | Title | Page |
| --- | --- | --- |
| `GET /voices/library` | Voice Library | [get-voices-library](https://lumean.app/en/developers/docs/md/api/get-voices-library) |
| `GET /voices/public` | Public Voices Catalog | [get-voices-public](https://lumean.app/en/developers/docs/md/api/get-voices-public) |
| `GET /voices/tags` | Voice Tags | [get-voices-tags](https://lumean.app/en/developers/docs/md/api/get-voices-tags) |
| `GET /voices` | My Voices | [get-voices](https://lumean.app/en/developers/docs/md/api/get-voices) |
| `GET /voices/{voice}` | Show Voice | [get-voices-voice](https://lumean.app/en/developers/docs/md/api/get-voices-voice) |

## External Voices

| Operation | Title | Page |
| --- | --- | --- |
| `GET /voices/elevenlabs/library` | ElevenLabs Voice Library | [get-voices-elevenlabs-library](https://lumean.app/en/developers/docs/md/api/get-voices-elevenlabs-library) |
| `GET /voices/heygen` | HeyGen Voices | [get-voices-heygen](https://lumean.app/en/developers/docs/md/api/get-voices-heygen) |
| `GET /voices/heygen/filters` | HeyGen Voice Filters | [get-voices-heygen-filters](https://lumean.app/en/developers/docs/md/api/get-voices-heygen-filters) |

## Cartesia Voices

| Operation | Title | Page |
| --- | --- | --- |
| `GET /voices/cartesia` | Cartesia Voices | [get-voices-cartesia](https://lumean.app/en/developers/docs/md/api/get-voices-cartesia) |
| `GET /voices/cartesia/clones/quota` | My Cartesia Voice Clone Quota | [get-voices-cartesia-clones-quota](https://lumean.app/en/developers/docs/md/api/get-voices-cartesia-clones-quota) |
| `GET /voices/cartesia/clones` | My Cartesia Voice Clones | [get-voices-cartesia-clones](https://lumean.app/en/developers/docs/md/api/get-voices-cartesia-clones) |
| `POST /voices/cartesia/clones` | Create Cartesia Voice Clone | [post-voices-cartesia-clones](https://lumean.app/en/developers/docs/md/api/post-voices-cartesia-clones) |
| `POST /voices/cartesia/clones/{voiceClone}/retry` | Retry Cartesia Voice Clone | [post-voices-cartesia-clones-voice-clone-retry](https://lumean.app/en/developers/docs/md/api/post-voices-cartesia-clones-voice-clone-retry) |
| `DELETE /voices/cartesia/clones/{voiceClone}` | Archive Cartesia Voice Clone | [delete-voices-cartesia-clones-voice-clone](https://lumean.app/en/developers/docs/md/api/delete-voices-cartesia-clones-voice-clone) |

## Fish Audio Voices

| Operation | Title | Page |
| --- | --- | --- |
| `GET /voices/fishaudio` | Fish Audio Voices | [get-voices-fishaudio](https://lumean.app/en/developers/docs/md/api/get-voices-fishaudio) |
| `GET /voices/fishaudio/clones/quota` | My Fish Audio Voice Clone Quota | [get-voices-fishaudio-clones-quota](https://lumean.app/en/developers/docs/md/api/get-voices-fishaudio-clones-quota) |
| `GET /voices/fishaudio/clones` | My Fish Audio Voice Clones | [get-voices-fishaudio-clones](https://lumean.app/en/developers/docs/md/api/get-voices-fishaudio-clones) |
| `POST /voices/fishaudio/clones` | Create Fish Audio Voice Clone | [post-voices-fishaudio-clones](https://lumean.app/en/developers/docs/md/api/post-voices-fishaudio-clones) |
| `POST /voices/fishaudio/clones/{voiceClone}/retry` | Retry Fish Audio Voice Clone | [post-voices-fishaudio-clones-voice-clone-retry](https://lumean.app/en/developers/docs/md/api/post-voices-fishaudio-clones-voice-clone-retry) |
| `DELETE /voices/fishaudio/clones/{voiceClone}` | Archive Fish Audio Voice Clone | [delete-voices-fishaudio-clones-voice-clone](https://lumean.app/en/developers/docs/md/api/delete-voices-fishaudio-clones-voice-clone) |

## Billing

| Operation | Title | Page |
| --- | --- | --- |
| `GET /usage` | Get Usage Limits | [get-usage](https://lumean.app/en/developers/docs/md/api/get-usage) |
| `GET /usage/{service}` | Get Usage for Service | [get-usage-service](https://lumean.app/en/developers/docs/md/api/get-usage-service) |

## Subscriptions

| Operation | Title | Page |
| --- | --- | --- |
| `GET /subscriptions` | Get subscriptions of API key owner | [get-subscriptions](https://lumean.app/en/developers/docs/md/api/get-subscriptions) |

## Profile

| Operation | Title | Page |
| --- | --- | --- |
| `GET /user` | Get profile of API key owner | [get-user](https://lumean.app/en/developers/docs/md/api/get-user) |

## AI Models

| Operation | Title | Page |
| --- | --- | --- |
| `GET /ai/models` | Current AI model prices | [get-ai-models](https://lumean.app/en/developers/docs/md/api/get-ai-models) |
| `GET /ai/models/{key}` | Current price of one AI model | [get-ai-models-key](https://lumean.app/en/developers/docs/md/api/get-ai-models-key) |

## Reseller

| Operation | Title | Page |
| --- | --- | --- |
| `GET /reseller` | Reseller profile | [get-reseller](https://lumean.app/en/developers/docs/md/api/get-reseller) |
| `GET /reseller/settings` | Gift code settings | [get-reseller-settings](https://lumean.app/en/developers/docs/md/api/get-reseller-settings) |
| `GET /reseller/statistics` | Reseller statistics | [get-reseller-statistics](https://lumean.app/en/developers/docs/md/api/get-reseller-statistics) |
| `GET /reseller/codes` | List my gift codes | [get-reseller-codes](https://lumean.app/en/developers/docs/md/api/get-reseller-codes) |
| `POST /reseller/codes` | Issue gift codes | [post-reseller-codes](https://lumean.app/en/developers/docs/md/api/post-reseller-codes) |
| `GET /reseller/codes/{uuid}` | Show my gift code | [get-reseller-codes-uuid](https://lumean.app/en/developers/docs/md/api/get-reseller-codes-uuid) |
| `POST /reseller/codes/{uuid}/cancel` | Cancel my gift code | [post-reseller-codes-uuid-cancel](https://lumean.app/en/developers/docs/md/api/post-reseller-codes-uuid-cancel) |

---

- This page in the browser: https://lumean.app/en/developers/docs/api
- Full machine-readable reference: https://api.lumean.app/docs/llm.md