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/orders/{order}/items/{item}

Get Order Item

Returns one chunk: status, duration, result file and the can_retry / can_regenerate flags.

orders.read

Those flags only reflect the chunk status (can_retry = policy_flagged/failed, can_regenerate = completed) and are not a guarantee: the call may still return 400 if the order is not partially_completed, the retry limit (5) is exhausted, no locked funds remain, or the task type is sfx/music.

Required key permission: orders.read.

Auf dieser Seite(4)

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/orders//items/

orderstringim Pfaderforderlich
Order UUID — 36 characters shaped like 9f8b2c1a-4d3e-4f5a-8b9c-0d1e2f3a4b5c, not a number.

Take it from the id field: POST /orders returns it on creation and GET /orders lists it. Someone else’s order will not open with your key — you get a 404.
Der Wert wird direkt in die Anfragezeile oben eingesetzt.
itemstringim Pfaderforderlich
Order chunk UUID — 36 characters; neither a number nor a position.

Take it from an item’s id field: GET /orders/{order}/items returns the list, and the same set sits in items[] of the detailed order response. The chunk’s position is the neighbouring chunk_index field, which does not go into the path.
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": "Order item loaded successfully.",
  "data": {
    "id": "d4e5f6a7-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
    "order_id": "9f8b2c1a-4d3e-4f5a-8b9c-0d1e2f3a4b5c",
    "item_type": "chunk",
    "chunk_index": 0,
    "parent_item_id": null,
    "original_text_length": 240,
    "current_text_length": 240,
    "price_units": 240,
    "consumed_units": 240,
    "remaining_locked": 0,
    "status": "completed",
    "result_file": {
      "path": "storage/501/orders/9f8b2c1a-4d3e-4f5a-8b9c-0d1e2f3a4b5c/output/chunks/0/result.mp3",
      "storage": "s3",
      "name": "chunk_0.mp3",
      "size": 512340,
      "mime_type": "audio/mpeg",
      "size_formatted": "500.33 KB"
    },
    "attempt_number": 1,
    "can_retry": false,
    "can_regenerate": true,
    "created_at": "2026-07-17T12:00:05+00:00",
    "updated_at": "2026-07-17T12:02:10+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

A single fragment of the order.

OrderItemOrderItem

iderforderlich

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

string

order_iderforderlich

UUID of the order this chunk belongs to.

string

item_typeerforderlich

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.

string

chunk_indexerforderlich

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

darf null sein

integer

paragraph_indexerforderlich

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.

string

parent_item_iderforderlich

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

string

original_text_lengtherforderlich

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

integer

current_text_lengtherforderlich

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

integer

price_unitserforderlich

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).

integer

consumed_unitserforderlich

How many tokens were actually charged for this fragment. Zero while the fragment is unfinished.

integer

remaining_lockederforderlich

How many tokens are still reserved for the fragment. Drops to zero once the fragment finishes or is cancelled.

integer

statuserforderlich

Fragment state: pending waits for a worker, processing is in flight, completed is done, failed hit a technical error, and policy_flagged was rejected by the content policy.

The difference between the last two dictates the fix: failed is cured by retrying as is, whereas policy_flagged requires rewording — retrying the same text is rejected again.

string

result_fileerforderlich

The finished fragment’s file: an absolute path, or a structure carrying path and size. Download it via POST /storage/url, same as order files. null until the fragment is ready.

darf null sein

object | string | null

duration_mserforderlich

Duration of the produced audio in milliseconds — the length of the recording, not the generation time. null for non-audio tasks.

darf null sein

integer

attempt_numbererforderlich

Attempt number for this fragment, starting at 1. It grows with every retry.

integer

can_retryerforderlich

Whether a free retry is allowed right now. It already accounts for status, task type and exhausted attempts, so you need not re-check the conditions.

boolean

can_regenerateerforderlich

Whether a paid regeneration is allowed right now. Available for finished fragments only.

boolean

created_aterforderlich

When the fragment was created, ISO 8601.

darf null seindate-time

string

updated_aterforderlich

When the fragment last changed, ISO 8601.

darf null seindate-time

string

failure_reasonoptional

Machine-readable failure reason — present only on failed and policy_flagged. Everything else gets null.

darf null sein

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

messageerforderlich

Error overview.

string

Ereignisse, die dabei entstehen

Der Fortschritt kommt über WebSocket: Der Auftrag muss nicht in einer Schleife abgefragt werden. Das Abonnement braucht dasselbe Recht wie das Lesen von Aufträgen.

Objekte

OrderItem

Benachbarte Operationen

Mehr

Diese Seite einer KI geben

.md öffnen llm.md

Spezifikation 0.0.1

Parameter

Mögliche Antworten

Ereignisse, die dabei entstehen

In der Nähe

Diese Seite einer KI geben