К содержанию
Lumean API

GET/templates/{template}

Возвращает один шаблон целиком, вместе с config и сервисом, к которому он привязан.

templates.read

Чужой шаблон недоступен даже по прямой ссылке — ответ 403.

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

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

Параметры

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

GEThttps://api.lumean.app/api/public/templates/
  • stringв путиобязательныйuuid

    UUID шаблона — 36 символов, не число.

    Берётся из поля id: его возвращает POST /templates при создании, а также GET /templates и GET /templates/browse в списках.

    Значение подставляется прямо в строку запроса выше.

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

200

Информация о шаблоне

Пример тела
{
  "success": true,
  "message": "Template retrieved",
  "data": {
    "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"
  }
}
Поля ответа
successобязательное

Признак успеха. Решение принимайте по HTTP-коду: у любого ответа 2xx здесь true, а ошибка приходит телом другой формы, где этого поля может не быть вовсе.

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

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

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

Шаблон целиком, вместе с текущим config.

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

Нет доступа к шаблону

Разобрать этот ответ
Пример тела
{
  "success": false,
  "message": "This API key does not have permission to perform this action."
}
Поля ответа
messageобязательное

Error overview.

string
404

Шаблон не найден

Разобрать этот ответ
Пример тела
{
  "success": false,
  "message": "Resource not found."
}
Поля ответа
successобязательное

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

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

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

string
reasonнеобязательное

Машиночитаемая причина — приходит у бизнес-отказов (например, invalid_order_status); у прочих ошибок поля нет. Ветвите обработку по нему, а не по тексту сообщения.

string
error_codeнеобязательное

Тот же машинный код, что в reason, — второе имя поля. Приходит вместе с reason, значения всегда совпадают.

string

Рядом

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

Объекты

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

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

Открыть .mdllm.md

спека 0.0.1