GET/templates

Постраничный список шаблонов владельца ключа: по умолчанию — корневые (без папки), новые первыми, не больше 30 на странице.

templates.read

Шаблон — сохранённый набор настроек генерации: сервис, голос, модель, формат вывода. Его id подставляется в template_id при создании заказа. Заводить шаблон на каждый заказ не нужно: один шаблон переиспользуется, а настройки под конкретный заказ меняет config_override в POST /orders.

Ответ: data.items[] — шаблоны, data.current_page / last_page / per_page / total — пагинация. Обход всех страниц: page=1, 2, … до current_page = last_page. Найти шаблон по названию — search, по сервису — service, внутри папки — folder_id; папки вместе с шаблонами — GET /templates/browse.

Прежний режим (устарел). Запрос без единого параметра по-прежнему отдаёт все корневые шаблоны одним массивом в data и несёт заголовки Deprecation и Sunset (дата снятия). После неё такой запрос получит первую страницу. Переход — добавить ?page=1 и читать data.items.

Требуемое право ключа: templates.read.

На этой странице(3)

Параметры

Поля ввода живут прямо в строке запроса: подставьте значение — и получите готовый URL. Ниже — тип, обязательность и допустимые значения каждого параметра.

GEThttps://api.lumean.app/api/public/templates

pageintegerв queryнеобязательный
Номер страницы, начиная с 1. Любой параметр списка включает постраничный ответ; запрос совсем без параметров — устаревший полный список (до 06.11.2026).
per_pageintegerв queryнеобязательный
Шаблонов на странице, 1..30. По умолчанию 30.
sort_bystringв queryнеобязательный
Поле сортировки. По умолчанию created_at (новые первыми при sort_order=desc).
Допустимые значения
sort_orderstringв queryнеобязательный
Направление сортировки. По умолчанию desc.
Допустимые значения
searchstringв queryнеобязательный
Подстрока названия шаблона. Регистр не учитывается.
servicestringв queryнеобязательный
Показать только шаблоны этого сервиса. Код — короткая латинская строка: elevenlabs, heygen, cartesia, sfx, music.
folder_idstringв queryнеобязательный
UUID папки. Не передан — шаблоны корня (folder_id = null).

Возможные ответы

200

TemplateCollection

Пример тела

{
  "success": true,
  "message": "Templates retrieved",
  "data": {
    "items": [
      {
        "id": "7e2a4c1d-8b3f-4a5e-9c6d-1f2e3a4b5c6d",
        "user_id": 501,
        "slug": null,
        "name": "Narrator Voice (EN)",
        "service_key": "elevenlabs",
        "service": {
          "id": 3,
          "code": "elevenlabs",
          "name": "ElevenLabs",
          "display_name": "ElevenLabs TTS",
          "payg_access": "everyone",
          "billing_mode": "pay_as_you_go",
          "unit_asset_id": 5,
          "unit_asset": {
            "id": 5,
            "code": "tts_units",
            "kind": "unit",
            "precision": 0,
            "name": "TTS Units",
            "deleted_at": null,
            "created_at": "2026-01-10T09:00:00+00:00",
            "updated_at": "2026-01-10T09:00:00+00:00"
          },
          "required_entitlement_id": null,
          "units_per_call": null,
          "units_per_char": 1,
          "units_per_image": null,
          "units_per_second": null,
          "min_billable_chars": 1,
          "lumcoin_per_token": 10,
          "lumc_precision": 2,
          "price_lumc_minor": null,
          "unit_size": 1,
          "uses_money_first_pricing": false,
          "rate_unit": "char",
          "display_category": "voice",
          "is_premium": false,
          "display_order": 1,
          "metadata": null,
          "is_active": true,
          "created_at": "2026-01-10T09:00:00+00:00",
          "updated_at": "2026-01-10T09:00:00+00:00"
        },
        "config": {
          "tts_settings": {
            "model_id": "eleven_multilingual_v2",
            "voice_id": "21m00Tcm4TlvDq8ikWAM",
            "mode": "mode_v1",
            "language_code": null,
            "advanced_voice_settings": true,
            "voice_settings": {
              "stability": 0.5,
              "similarity_boost": 0.75,
              "use_speaker_boost": true
            }
          }
        },
        "is_public": false,
        "folder_id": null,
        "created_at": "2026-06-01T10:00:00+00:00",
        "updated_at": "2026-06-01T10:00:00+00:00"
      },
      {
        "id": "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
        "user_id": 501,
        "slug": null,
        "name": "Podcast Host (RU)",
        "service_key": "elevenlabs",
        "service": {
          "id": 3,
          "code": "elevenlabs",
          "name": "ElevenLabs",
          "display_name": "ElevenLabs TTS",
          "payg_access": "everyone",
          "billing_mode": "pay_as_you_go",
          "unit_asset_id": 5,
          "unit_asset": {
            "id": 5,
            "code": "tts_units",
            "kind": "unit",
            "precision": 0,
            "name": "TTS Units",
            "deleted_at": null,
            "created_at": "2026-01-10T09:00:00+00:00",
            "updated_at": "2026-01-10T09:00:00+00:00"
          },
          "required_entitlement_id": null,
          "units_per_call": null,
          "units_per_char": 1,
          "units_per_image": null,
          "units_per_second": null,
          "min_billable_chars": 1,
          "lumcoin_per_token": 10,
          "lumc_precision": 2,
          "price_lumc_minor": null,
          "unit_size": 1,
          "uses_money_first_pricing": false,
          "rate_unit": "char",
          "display_category": "voice",
          "is_premium": false,
          "display_order": 1,
          "metadata": null,
          "is_active": true,
          "created_at": "2026-01-10T09:00:00+00:00",
          "updated_at": "2026-01-10T09:00:00+00:00"
        },
        "config": {
          "tts_settings": {
            "model_id": "eleven_multilingual_v2",
            "voice_id": "AZnzlk1XvdvUeBnXmlld",
            "mode": "mode_v1",
            "language_code": "ru",
            "advanced_voice_settings": true,
            "voice_settings": {
              "stability": 0.4,
              "similarity_boost": 0.8,
              "use_speaker_boost": true
            }
          }
        },
        "is_public": false,
        "folder_id": null,
        "created_at": "2026-06-10T08:00:00+00:00",
        "updated_at": "2026-06-10T08:00:00+00:00"
      }
    ],
    "current_page": 1,
    "last_page": 1,
    "per_page": 30,
    "total": 2
  }
}

Поля ответа

dataобязательное

Страница шаблонов владельца ключа (не больше 30): items и мета пагинации. Обход с папками — GET /templates/browse.

TemplateListTemplateList

itemsобязательное

Записи текущей страницы в порядке сортировки списка.

array<Template>Template

элемент массива

idобязательное

UUID шаблона. Его кладут в template_id при создании заказа.

string

user_idобязательное

ID владельца шаблона.

integer

slugобязательное

Короткий публичный идентификатор для расшаривания. null у шаблона, которым не делились.

string

nameобязательное

Название шаблона — только для человека, на поведение генерации не влияет.

string

service_keyобязательное

Код сервиса, по схеме которого валидируется config: elevenlabs, lumimg и т. д.

string

serviceобязательное

Сервис шаблона справочно: название и тарификация, без схем конфигурации. null означает, что сервиса с таким кодом больше нет.

может быть null

Service | null

configобязательное

Настройки генерации: голос, модель, скорость и прочее — набор ключей задаёт сервис. Допустимые значения смотрите в GET /templates/config-options?service=<код>, значение вне схемы отклоняется с 422. В заказе (template в GET /orders/{order}) это настройки самого заказа — снимок на момент его создания с config_override, а не текущий конфиг шаблона (у заказов, созданных до конца сентября 2026 года, — текущий конфиг шаблона с config_override).

object

is_publicобязательное

Опубликован ли шаблон в общем каталоге.

boolean

folder_idобязательное

UUID папки, в которой лежит шаблон, либо null для корня. Структура папок видна в GET /templates/browse.

string

created_atобязательное

Когда шаблон создан, ISO 8601.

может быть nulldate-time

string

updated_atобязательное

Когда шаблон последний раз менялся, ISO 8601.

может быть nulldate-time

string

current_pageобязательное

Номер текущей страницы, с единицы.

integer

last_pageобязательное

Номер последней страницы. Обход списка закончен, когда current_page равен last_page.

integer

per_pageобязательное

Размер страницы, применённый сервером.

integer

totalобязательное

Сколько записей всего по фильтру.

integer

401

Невалидный или отсутствующий X-API-KEY

Разобрать этот ответ

Пример тела

{
  "success": false,
  "message": "API key is missing. Provide it in the X-API-KEY header.",
  "data": null
}

Поля ответа

successобязательное

Всегда false в ответах об ошибке.

boolean

messageобязательное

Текст ошибки на языке ключа (задаётся заголовком X-Locale).

string

dataобязательное

Всегда null, когда запрос отклонён до обработки.

может быть null

null

403

У ключа нет права templates.read

Разобрать этот ответ

Пример тела

{
  "success": false,
  "message": "This API key does not have permission to perform this action."
}

Поля ответа

successобязательное

Всегда false в ответах об ошибке.

boolean

messageобязательное

Текст ошибки на языке ключа (задаётся заголовком X-Locale).

string

422

Ошибка валидации. Поля с ошибками перечислены в errors.

Разобрать этот ответ

Пример тела

{
  "message": "string",
  "errors": {}
}

Поля ответа

messageобязательное

Errors overview.

string

errorsобязательное

A detailed description of each field that failed validation.

object

*необязательное

произвольные ключи

array<string>

Об этом словами

Объекты

Соседние операции

Ещё

Скормить страницу ИИ

Открыть .md llm.md

спека 0.0.1

Параметры

Возможные ответы

Рядом

Скормить страницу ИИ