API objects

То самое имя, которое надо ставить в поле model запроса. Оно же единственное принимаемое: гейтвей резолвит его точным совпадением и уже сам подставляет имя модели на стороне поставщика.

chat | image. Модель image зовут через /v1/images (или чатом — ответ придёт markdown-картинкой), цена — price.request.

Вызываема ли модель платным ключом. false при живой модели — она видна ради своего ключа (BYOK), а платный вызов откажет.

Internal identifier of the asset.

Asset code: LUMC is the internal currency, TOKEN the generation tokens.

Kind of asset: money or consumable units. It decides whether an amount counts as a payment or as quota consumption.

Number of decimal places. The load-bearing field: every integer amount in this asset is divided by 10^precision to obtain the real value. Do not assume the divisor is 100.

Display name of the asset, in the account language.

When the asset was retired, ISO 8601. null while it is in use.

When the asset was created, ISO 8601.

When the asset last changed, ISO 8601.

Current page number, starting at 1.

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

How many records fit on a page.

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

Clone UUID. Use it in /voices/cartesia/clones/{voiceClone}/… paths; it does NOT go into a template — voice_id does.

Clone provider — always cartesia.

Clone name given at creation.

Language of the sample (ISO 639-1), or null if none was sent.

Your description of the clone, or null.

Status: pending → cloning → ready or failed; archived — retired by the owner; banned — blocked by a moderator. Only ready can be used for narration.

The Cartesia voice id — the value for tts_settings.voice_id of a template with service_key: cartesia. Present only for ready, otherwise null.

Cloning attempt number: 1 on creation, +1 for every retry.

When the clone was created.

When the clone became ready; null until then.

When the last attempt failed; null if it has not.

When a moderator banned the clone (status = banned); null if it is not banned.

Reason for the ban given by the moderator, or null. A banned clone can be neither used nor archived.

Internal id of the catalogue entry. Not needed for narration — voice_id goes into the template.

The Cartesia voice id — the value for tts_settings.voice_id of a template with service_key: cartesia.

Voice name.

Voice description from Cartesia, or null.

Voice language (ISO 639-1), or null.

Voice gender: masculine, feminine, gender_neutral, or null.

Link to a voice preview recording, or null.

Clone name — visible only to you, up to 128 characters.

The voice sample in base64; a data URI (data:audio/wav;base64,…) works too. Up to 20 MB once decoded; any common audio format (WAV, MP3 and the like). It should be clean speech by a single person, without music or noise.

Language of the sample, an ISO 639-1 code from the list. Omitted — the default language of the worker.

Your description of the clone, up to 500 characters.

Consent to processing of biometric data — the voice sample (https://lumean.app/consent/biometric). Recorded in the consent journal together with the clone id. true — consent given.

Whose voice is in the sample: self — yours, third_party — someone else's, and you hold their consent.

The former checkbox "the voice is yours or you hold the right to use it". Needed only if consent_biometric: true is not sent; once consents become mandatory, send consent_biometric and voice_owner instead.

Clone name — visible only to you, up to 128 characters.

The voice sample in base64; a data URI (data:audio/wav;base64,…) works too. Up to 20 MB once decoded; any common audio format (WAV, MP3 and the like). It should be clean speech by a single person, without music or noise.

A reference label for the clone, a two-letter ISO 639-1 code (ru, en, …). Fish Audio voices have no language of their own and the label is not sent to the provider.

Your description of the clone, up to 500 characters.

Consent to processing of biometric data — the voice sample (https://lumean.app/consent/biometric). Recorded in the consent journal together with the clone id. true — consent given.

Whose voice is in the sample: self — yours, third_party — someone else's, and you hold their consent.

The former checkbox "the voice is yours or you hold the right to use it". Needed only if consent_biometric: true is not sent; once consents become mandatory, send consent_biometric and voice_owner instead.

Internal identifier of the entitlement.

Entitlement code — a service checks it to decide whether you have access.

Display name of the entitlement, in the account language.

Extra attributes of the entitlement. The key set is free-form.

Whether the entitlement is active.

When the entitlement was created, ISO 8601.

When the entitlement last changed, ISO 8601.

Whether this capability is unlimited under the plan. Present only when the entitlement is returned in a plan context.

Clone UUID. Use it in /voices/fishaudio/clones/{voiceClone}/… paths; it does NOT go into a template — voice_id does.

Clone provider — always fishaudio.

Clone name given at creation.

Reference language label (ISO 639-1), or null if none was sent. It does not affect cloning.

Your description of the clone, or null.

Status: pending → cloning → ready or failed; archived — retired by the owner; banned — blocked by a moderator. Only ready can be used for narration.

The Fish Audio voice id (a 32-character hex string, not a UUID) — the value for tts_settings.voice_id of a template with service_key: fishaudio. Present only for ready, otherwise null.

Cloning attempt number: 1 on creation, +1 for every retry.

When the clone was created.

When the clone became ready; null until then.

When the last attempt failed; null if it has not.

When a moderator banned the clone (status = banned); null if it is not banned.

Reason for the ban given by the moderator, or null. A banned clone can be neither used nor archived.

Internal id of the catalogue entry. Not needed for narration — voice_id goes into the template.

The Fish Audio voice id (a 32-character hex string, not a UUID) — the value for tts_settings.voice_id of a template with service_key: fishaudio.

Voice name.

Voice description from Fish Audio, or null.

Catalogue language the voice was imported under (ru, en, es), or null.

All languages of the voice according to Fish Audio.

Voice gender: male, female, or null.

Voice tags at Fish Audio.

Voice author at Fish Audio, or null.

How many times the voice has been used at Fish Audio — a popularity measure; the catalogue is sorted by it.

Number of likes of the voice at Fish Audio.

A temporary link (60 minutes) to an MP3 sample of the voice, or null while the preview has not been downloaded yet.

The full file path exactly as it arrived in the order's result.files[] or result.service_files[]. Do not assemble it by hand — it contains internal segments.

When true, the link is marked as an attachment: the file is saved under the human-readable order name instead of opening in a browser tab.

Where chunk numbering starts in the file name: 1 → the first chunk is "001", 0 → "000". Defaults to 1.

Width of the zero-padded chunk number, 1..4: 3 → "007". Defaults to 3. Keep it identical to the ZIP archive request, otherwise the same chunk is named differently on its own and inside the archive.

The batch id.

Always reseller — the batch was issued from the reseller balance.

How many codes the batch holds.

Sum of the code nominals, LMC minor units.

Sum of the nominals, LMC.

How much was charged to the reseller balance (nominals minus the discount), LMC minor units.

Charged to the reseller balance, LMC.

The reseller personal discount at issue time, basis points (1000 = 10%).

When the batch was issued.

Current page number, starting from one.

Number of the last page. The walk is over once current_page equals last_page.

Page size the server applied.

Total number of records matching the filter.

Code UUID. Use it in the GET /reseller/codes/{uuid} and POST /reseller/codes/{uuid}/cancel paths.

The code with a mask, LUM-****-****-XXXX: safe to show in a UI and to write to logs.

The FULL code value — what the recipient types to redeem it. The reseller public API returns it in the list, on show and on issue. Treat it as a secret: whoever knows the code can redeem it.

The code’s nominal value in minor LMC units: real = nominal / 10^currency_asset.precision. This is how much LMC the redeemer receives.

The same nominal value in whole LMC — a number ready to display.

What the code cost the reseller after the discount, in minor LMC units. Present only for reseller codes (source: reseller).

The same cost in whole LMC. Present only for reseller codes.

The reseller’s discount at the moment of issue, in basis points (100 = 1%). A later change of the personal discount does not affect this code. Present only for reseller codes.

The moment from which the code can be redeemed; until then it is frozen. null means no restriction.

When the code was redeemed. null until it is. The API never reveals who redeemed it.

When the reseller cancelled the code. null if it was not cancelled.

When the code was issued.

Code nominals in LMC, one number per code: as many codes as elements. Numbers and decimal strings are accepted; a nominal is either one of the presets from GET /reseller/settings or between min_nominal and max_nominal. The number of elements is capped by limits.max_codes_per_issue from GET /reseller.

Current page number, starting from one.

Number of the last page. The walk is over once current_page equals last_page.

Page size the server applied.

Total number of records matching the filter.

Voice UUID. Put it into a template’s config.voice_id; the same value goes into /voices/{voice} paths.

Display name of the voice.

Author’s description of the voice: timbre, delivery, intended use.

Voice gender.

Accent or regional pronunciation variant.

The language the voice defaults to, ISO-639-1.

Cloning state of the voice. Only a fully prepared voice can be used in orders.

Publication stage: draft, under review, published. It determines whether the voice appears in the shared catalogue GET /voices/public.

Whether the author lets others use the voice. Without this flag the voice is absent from the GET /voices/public catalogue, and library entries other users already made for it become unavailable.

When the preview clips were produced, ISO 8601. null means there is no preview yet.

When the voice was created, ISO 8601.

When the voice last changed, ISO 8601.

Orders of the current page.

Current page number, starting from 1.

Number of the last page.

Items per page.

Total items matching the filter.

Chunk UUID. Use it in /orders/{order}/items/{item}/… paths.

UUID of the order this chunk belongs to.

What the record is: chunk is an original fragment, retry a free re-run of a failed one, regeneration a paid redo of a finished one.

Retries and regenerations are separate records sharing the same chunk_index: the full attempt history is kept, and the last one is what the result plays.

Zero-based position of the fragment within the order. It defines the order in which the final file is assembled.

The paragraph this fragment belongs to — filled in only for the original fragments of a paragraph-mode order. It is null both in ordinary mode and on retry or regeneration records: those carry no paragraph link of their own and inherit it from the parent fragment via parent_item_id. The mode is switched on by the generation_mode key in the order's config_override.

UUID of the source chunk — present on retry and regeneration records. null on an original chunk.

Length of the text the fragment was created with. It is the ceiling for text in regenerate.

Length of the fragment’s current text: after a regeneration it differs from original_text_length.

Cost of the fragment in tokens — not money. The monetary amount lives on the order itself, in its own price_units field (LMC there, tokens here; the names match, the units do not).