Zum Inhalt
Lumean API

Beschreibungen auf Englisch

Die Oberfläche des Bereichs ist in Ihre Sprache übersetzt, Beschreibungen von Operationen, Schemata und Fehlern gibt es aber nur auf Russisch und Englisch — hier wird die englische Fassung angezeigt.
GET/templates/{template}

Get Template

Returns one template in full, including its config and the service it is bound to.

templates.read

Someone else's template is not reachable even by direct link — 403.

Required key permission: templates.read.

Auf dieser Seite(3)

Parameter

Die Eingabefelder liegen direkt in der Anfragezeile: Wert eintragen und die URL ist fertig. Darunter stehen Typ, Pflichtangabe und erlaubte Werte jedes Parameters.

GEThttps://api.lumean.app/api/public/templates/
  • stringim Pfaderforderlichuuid

    Template UUID — 36 characters, not a number.

    Take it from the id field: POST /templates returns it on creation, and GET /templates and GET /templates/browse list it.

    Der Wert wird direkt in die Anfragezeile oben eingesetzt.

Mögliche Antworten

200

Success. The payload is in data.

Beispiel für den Body
{
  "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"
  }
}
Felder der Antwort
successerforderlich

Success flag. Branch on the HTTP status code instead: any 2xx response carries true here, while an error comes back in a different shape that need not contain this field at all.

boolean
messageerforderlich

A human-readable note in the account language. Fine to show to a user; do not parse it — the wording changes without notice and is not an error code.

string
dataerforderlich

The full template, including its current config.

TemplateTemplate
iderforderlich

Template UUID. Put it into template_id when creating an order.

string
user_iderforderlich

ID of the template owner.

integer
slugerforderlich

Short public identifier used for sharing. null on a template that was never shared.

string
nameerforderlich

Template name — for humans only; it does not affect generation.

string
service_keyerforderlich

Code of the service whose schema validates config: elevenlabs, lumimg, and so on.

string
serviceerforderlich

The template’s service for reference: name and pricing, without configuration schemas. null means no service with that code exists any more.

darf null sein
Service | null
configerforderlich

Generation settings: voice, model, speed and so on — the set of keys is defined by the service. Look up allowed values in GET /templates/config-options?service=<code>; anything outside the schema is rejected with 422. Inside an order (template in GET /orders/{order}) this is the order’s own settings — the snapshot taken at creation with config_override applied, not the template’s current configuration (for orders created before late September 2026 — the current template configuration with config_override).

object
is_publicerforderlich

Whether the template is published in the shared catalogue.

boolean
folder_iderforderlich

UUID of the folder holding the template, or null for the root. The folder tree is visible in GET /templates/browse.

string
created_aterforderlich

When the template was created, ISO 8601.

darf null seindate-time
string
updated_aterforderlich

When the template last changed, ISO 8601.

darf null seindate-time
string
401

The key is missing, unknown, disabled or expired.

Diese Antwort analysieren
Beispiel für den Body
{
  "success": false,
  "message": "API key is missing. Provide it in the X-API-KEY header.",
  "data": null
}
Felder der Antwort
successerforderlich

Always false in error responses.

boolean
messageerforderlich

Error text in the key's language (set through the X-Locale header).

string
dataerforderlich

Always null when the request is rejected before processing.

darf null sein
null
403

The key lacks the required permission, or the object belongs to another user.

Diese Antwort analysieren
Beispiel für den Body
{
  "success": false,
  "message": "This API key does not have permission to perform this action."
}
Felder der Antwort
messageerforderlich

Error overview.

string
404

Not found, or not reachable with this key.

Diese Antwort analysieren
Beispiel für den Body
{
  "success": false,
  "message": "Resource not found."
}
Felder der Antwort
successerforderlich

Always false in error responses.

boolean
messageerforderlich

Error text in the key's language (set through the X-Locale header).

string
reasonoptional

Machine-readable reason — present on business refusals (for example, invalid_order_status); other errors omit it. Branch on it, not on the message text.

string
error_codeoptional

The same machine-readable code as in reason — a second name for the field. Arrives together with reason; the values always match.

string

In der Nähe

Dasselbe in Worten

Objekte

Diese Seite einer KI geben

.md öffnenllm.md

Spezifikation 0.0.1