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/browse

Browse Templates

Paginated walk through the template tree: folders and templates in one data.items[] list, folders first.

With no folder_id you get the root. To descend, take a folder's id from items[] and repeat with ?folder_id=<id>; the path to the current folder arrives in data.breadcrumbs, the folder itself in data.current_folder.

Pagination lives in data.current_page / last_page / per_page / total.

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/browse
  • integerin der Queryoptional≥ 1

    Page number, starting at 1.

  • integerin der Queryoptional1..100

    Items per page, 1..100. Defaults to 15.

  • stringin der Queryoptional

    Sort field. Defaults to name.

    Zulässige Werte
  • stringin der Queryoptional

    Sort direction. Defaults to asc.

    Zulässige Werte
  • stringin der Queryoptionaluuid

    Folder UUID. Omitted — the root is returned. The path to the current folder arrives in data.breadcrumbs.

  • stringin der Queryoptional≤ 64 Zeichen

    Show only templates of services with this task type (the service default_task_type), e.g. tts for every voiceover engine at once. Empty folders are hidden while filtering.

  • stringin der Queryoptional

    Show only templates of this service. The code is a short latin string: elevenlabs, heygen, lumimg, sfx, music; the ones available to you are listed by GET /usage in its service_code field.

Mögliche Antworten

200

Success. The payload is in data.

Beispiel für den Body
{
  "success": true,
  "message": "Templates browsed",
  "data": {
    "items": [
      {
        "type": "template",
        "id": "7e2a4c1d-8b3f-4a5e-9c6d-1f2e3a4b5c6d",
        "name": "Narrator Voice (EN)",
        "slug": null,
        "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"
      },
      {
        "type": "folder",
        "id": "c1d2e3f4-5a6b-4c7d-8e9f-0a1b2c3d4e5f",
        "name": "Podcast Intros",
        "templates_count": 3,
        "created_at": "2026-05-01T09:00:00+00:00",
        "updated_at": "2026-05-01T09:00:00+00:00"
      }
    ],
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 2,
    "current_folder": null,
    "breadcrumbs": [
      {
        "id": null,
        "name": "Root"
      }
    ]
  }
}
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

Folder contents with pagination and an ancestor trail — meant for a template tree in a UI.

BrowseTemplatesBrowseTemplates
itemserforderlich

Contents of the current folder — folders and templates interleaved, in sort order. Tell them apart by service_key: only a template has it.

array<TemplateItem>TemplateItem
Array-Element
typeerforderlich
Wertetemplate
string
iderforderlich
string
nameerforderlich
string
slugoptional
string
service_keyoptional
string
serviceoptional
darf null sein
Service | null
configoptional
object | string
is_publicoptional
string
folder_idoptional
string
created_aterforderlich
string
updated_aterforderlich
string
templates_countoptional
string | integer
current_pageerforderlich

Current page number, starting at 1.

integer
last_pageerforderlich

Number of the last page. When it equals current_page, there is nothing further.

integer
per_pageerforderlich

How many records fit on a page.

integer
totalerforderlich

How many records the folder holds in total, across all pages.

integer
current_foldererforderlich

The folder whose contents are shown. null means you are at the root.

darf null sein
object
iderforderlich

UUID of the current folder — pass it as folder_id to open the folder again.

string
nameerforderlich

Name of the current folder.

string
breadcrumbserforderlich

The path from the root to the current folder, ancestor first — ready to render as a breadcrumb trail.

array<object>
Array-Element
idoptional

UUID of an ancestor folder — the folder_id value that jumps back to that level.

uuid
string
nameoptional

Name of the ancestor folder.

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
successerforderlich

Always false in error responses.

boolean
messageerforderlich

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

string
422

Validation error. Offending fields are listed in errors.

Diese Antwort analysieren
Beispiel für den Body
{
  "message": "string",
  "errors": {}
}
Felder der Antwort
messageerforderlich

Errors overview.

string
errorserforderlich

A detailed description of each field that failed validation.

object
*optional
beliebige Schlüssel
array<string>

Diese Seite einer KI geben

.md öffnenllm.md

Spezifikation 0.0.1