{ "asyncapi": "2.6.0", "info": { "title": "Laravel Public WebSocket API", "version": "0.0.1", "description": "## Public WebSocket API (X-API-KEY)\n\nReal-time order and Cartesia / Fish Audio voice-clone events for Public API clients. The protocol is Pusher-compatible, so\nstandard libraries work as-is: **pusher-js** or **Laravel Echo**.\n\n### Connecting\n\nPoint your client at the server below and set the auth endpoint to\n`POST /api/public/broadcasting/auth`, adding the `X-API-KEY` header to its auth\nheaders. The library performs that request itself on every subscription. The key\npermission depends on the channel: order and chunk-preview channels need `orders.read`,\nthe Cartesia and Fish Audio voice-clone channels need `voices.read`, the reseller gift code channel needs\n`reseller.read`.\n\n### Channels\n\n- `private-orders.{userId}` — events for every order of the account. `{userId}` is the\n numeric id of the key owner, returned by `GET /user`.\n- `private-order.task.{orderId}` — events for a single order, including live progress.\n- `private-chunks.preview.{userId}` — the result of a background chunk-preview calculation.\n- `private-cartesia-voice-clones.{userId}` — status changes of your Cartesia voice clones\n (`voice_clone.updated`); a clone in `ready` carries the `voice_id` for a template.\n- `private-fishaudio-voice-clones.{userId}` — status changes of your Fish Audio voice clones\n (`voice_clone.updated`); the `voice_id` is a 32-character hex string, not a UUID.\n- `private-giftcodes.{userId}` — reseller gift codes and reseller status: `issued` (a batch\n summary), `status.changed` (a code), `reseller.status.changed` and\n `reseller.application.status.changed`. Events carry masked codes only.\n\nEvery channel is private: a channel belonging to another account is refused with `403`.\n\n### What this replaces\n\nSubscribing removes the need to poll `GET /orders/{order}`. Wait for the order to reach\na terminal status (`completed`, `result_delivered`, `failed`, `compensated`,\n`cancelled`), then request download links via `POST /storage/url`.\n\nEvents are delivered at least once and may arrive out of order — treat each one as a\nstate snapshot rather than a step in a sequence." }, "servers": { "public": { "url": "ws.lumean.app:443", "protocol": "wss", "description": "A WebSocket server speaking the Pusher protocol.", "security": [ { "apiKey": [] } ], "x-app-key": "7c4dd881d8116ac76fe89aff71d8c2ff" } }, "channels": { "private-orders.{userId}": { "description": "Events for every order of the account at once. `{userId}` is the numeric id of the key owner, returned by `GET /user`.", "parameters": { "userId": { "schema": { "type": "integer" } } }, "bindings": { "ws": { "method": "GET", "bindingVersion": "latest" } }, "subscribe": { "operationId": "private_orders_userId_subscribe", "message": { "oneOf": [ { "$ref": "#/components/messages/private_orders_userId__policy_cooldown_applied" }, { "$ref": "#/components/messages/private_orders_userId__paragraph_regenerate_completed" }, { "$ref": "#/components/messages/private_orders_userId__created" }, { "$ref": "#/components/messages/private_orders_userId__progress" }, { "$ref": "#/components/messages/private_orders_userId__voice_search_queue_updated" }, { "$ref": "#/components/messages/private_orders_userId__bulk_retry_completed" }, { "$ref": "#/components/messages/private_orders_userId__renamed" }, { "$ref": "#/components/messages/private_orders_userId__status_changed" }, { "$ref": "#/components/messages/private_orders_userId__archive_ready" }, { "$ref": "#/components/messages/private_orders_userId__item_status_changed" }, { "$ref": "#/components/messages/private_orders_userId__policy_cooldown_cleared" }, { "$ref": "#/components/messages/private_orders_userId__archive_failed" }, { "$ref": "#/components/messages/private_orders_userId__stitch_changed" }, { "$ref": "#/components/messages/private_orders_userId__archive_progress" } ] } } }, "private-order.task.{orderId}": { "description": "Events for a single order. `{orderId}` is the UUID from the `POST /orders` response. Someone else's order is out of reach: subscription auth returns `403`.", "parameters": { "orderId": { "schema": { "type": "integer" } } }, "bindings": { "ws": { "method": "GET", "bindingVersion": "latest" } }, "subscribe": { "operationId": "private_order_task_orderId_subscribe", "message": { "oneOf": [ { "$ref": "#/components/messages/private_order_task_orderId__paragraph_regenerate_completed" }, { "$ref": "#/components/messages/private_order_task_orderId__voice_search_queue_updated" }, { "$ref": "#/components/messages/private_order_task_orderId__bulk_retry_completed" }, { "$ref": "#/components/messages/private_order_task_orderId__renamed" }, { "$ref": "#/components/messages/private_order_task_orderId__status_changed" }, { "$ref": "#/components/messages/private_order_task_orderId__item_status_changed" }, { "$ref": "#/components/messages/private_order_task_orderId__stitch_changed" }, { "$ref": "#/components/messages/private_order_task_orderId__progress" } ] } } }, "private-chunks.preview.{userId}": { "description": "The result of a background chunk-preview split calculation. Arrives for large texts submitted to `POST /orders/chunks/preview`. `{userId}` is the numeric id of the key owner, returned by `GET /user`.", "parameters": { "userId": { "schema": { "type": "integer" } } }, "bindings": { "ws": { "method": "GET", "bindingVersion": "latest" } }, "subscribe": { "operationId": "private_chunks_preview_userId_subscribe", "message": { "$ref": "#/components/messages/private_chunks_preview_userId__ready" } } }, "private-cartesia-voice-clones.{userId}": { "description": "Progress of your Cartesia voice clones: one event per status change of a clone created via `POST /voices/cartesia/clones` (or in the web dashboard). `{userId}` is the numeric id of the key owner, returned by `GET /user`. Key permission: `voices.read`.", "parameters": { "userId": { "schema": { "type": "integer" } } }, "bindings": { "ws": { "method": "GET", "bindingVersion": "latest" } }, "subscribe": { "operationId": "private_cartesia_voice_clones_userId_subscribe", "message": { "$ref": "#/components/messages/private_cartesia_voice_clones_userId__voice_clone_updated" } } }, "private-fishaudio-voice-clones.{userId}": { "description": "Progress of your Fish Audio voice clones: one event per status change of a clone created via `POST /voices/fishaudio/clones` (or in the web dashboard). `{userId}` is the numeric id of the key owner, returned by `GET /user`. Key permission: `voices.read`.", "parameters": { "userId": { "schema": { "type": "integer" } } }, "bindings": { "ws": { "method": "GET", "bindingVersion": "latest" } }, "subscribe": { "operationId": "private_fishaudio_voice_clones_userId_subscribe", "message": { "$ref": "#/components/messages/private_fishaudio_voice_clones_userId__voice_clone_updated" } } }, "private-giftcodes.{userId}": { "description": "Gift codes and reseller status of the key owner: a batch issued, a code changing status, the reseller status and the reseller application changing. Events never carry code values, only masks; the full code comes from `GET /reseller/codes` and `GET /reseller/codes/{uuid}`. `{userId}` is the numeric id of the key owner, returned by `GET /user`. Key permission: `reseller.read`.", "parameters": { "userId": { "schema": { "type": "integer" } } }, "bindings": { "ws": { "method": "GET", "bindingVersion": "latest" } }, "subscribe": { "operationId": "private_giftcodes_userId_subscribe", "message": { "oneOf": [ { "$ref": "#/components/messages/private_giftcodes_userId__status_changed" }, { "$ref": "#/components/messages/private_giftcodes_userId__issued" }, { "$ref": "#/components/messages/private_giftcodes_userId__reseller_application_status_changed" }, { "$ref": "#/components/messages/private_giftcodes_userId__reseller_status_changed" } ] } } } }, "components": { "securitySchemes": { "apiKey": { "type": "httpApiKey", "name": "X-API-KEY", "in": "header", "description": "A subscription is authorized by `POST /api/public/broadcasting/auth` with the `X-API-KEY` header; the key needs the `orders.read` permission. Client libraries issue that request themselves — you only point them at the endpoint and add the header." } }, "messages": { "private_orders_userId__policy_cooldown_applied": { "name": "policy_cooldown.applied", "title": "Policy cooldown applied", "summary": "Policy cooldown applied", "payload": { "type": "object", "required": [ "reason", "minutes", "retry_after", "retry_at", "level", "threshold" ], "properties": { "reason": { "type": "string", "example": "policy_cooldown_active" }, "minutes": { "type": "integer", "example": 1 }, "retry_after": { "type": "integer", "example": 0 }, "retry_at": { "type": "string", "example": "1970-01-01T00:00:01+00:00" }, "level": { "type": "integer", "example": 1 }, "threshold": { "type": "integer", "example": 1 } } } }, "private_orders_userId__paragraph_regenerate_completed": { "name": "paragraph_regenerate.completed", "title": "Paragraph regenerate completed", "summary": "Paragraph regenerate completed", "payload": { "type": "object", "required": [ "order_id", "paragraph_index", "created_count", "failed_count" ], "properties": { "order_id": { "type": "string", "example": "01a0d8c6-86d3-70b5-a86e-5a12b1d860df" }, "paragraph_index": { "type": "integer", "example": 1 }, "created_count": { "type": "integer", "example": 1 }, "failed_count": { "type": "integer", "example": 1 } } } }, "private_orders_userId__created": { "name": "created", "title": "Created", "summary": "A new order was created.", "payload": { "type": "object", "required": [ "order", "items_summary" ], "properties": { "order": { "type": "object", "description": "A snapshot of the order without the chunk list — it would not fit the WebSocket message size limit. The status here is always `created`; fetch the chunks from `GET /orders/{order}`.", "properties": { "id": { "type": "integer", "example": 1024 }, "uuid": { "type": "string", "format": "uuid" }, "user_id": { "type": "integer", "example": 7 }, "status": { "type": "string", "enum": [ "created", "queued", "processing", "completed", "failed", "cancelled" ], "example": "created" }, "task_type": { "type": "string", "nullable": true }, "total_amount": { "type": "number", "example": 12.5 }, "created_at": { "type": "string", "format": "date-time" }, "template": { "type": "object" } } }, "items_summary": { "type": "object", "description": "A summary of the order's chunks instead of the full list.", "required": [ "total", "by_status" ], "properties": { "total": { "type": "integer", "example": 12 }, "by_status": { "type": "object", "description": "How many chunks are in each status: `pending`, `processing`, `completed`, `failed`, `policy_flagged`.", "additionalProperties": { "type": "integer" }, "example": { "pending": 12 } } } } } } }, "private_orders_userId__progress": { "name": "progress", "title": "Progress", "summary": "The order's overall progress was updated.", "payload": { "type": "object", "description": "Progress across the order's original chunks. Retries and regenerations are not counted.", "required": [ "order_id", "completed", "total", "percent" ], "properties": { "order_id": { "type": "string", "format": "uuid", "example": "019bb198-78f5-7082-8550-fee362917f2e" }, "completed": { "type": "integer", "example": 3 }, "total": { "type": "integer", "example": 7 }, "percent": { "type": "integer", "minimum": 0, "maximum": 100, "example": 43 } } } }, "private_orders_userId__voice_search_queue_updated": { "name": "voice_search.queue.updated", "title": "Voice search queue updated", "summary": "Voice search queue updated", "payload": { "type": "object", "required": [ "order_id", "queue_position", "queue_wait_seconds" ], "properties": { "order_id": { "type": "string", "example": "example" }, "queue_position": { "type": "integer", "example": 1 }, "queue_wait_seconds": { "type": [ "integer", "null" ], "example": 1 } } } }, "private_orders_userId__bulk_retry_completed": { "name": "bulk_retry.completed", "title": "Bulk retry completed", "summary": "Bulk retry completed", "payload": { "type": "object", "required": [ "order_id", "created_count", "failed_count" ], "properties": { "order_id": { "type": "string", "example": "01a0d8c6-86b5-706a-958a-a626ddb3ba3d" }, "created_count": { "type": "integer", "example": 1 }, "failed_count": { "type": "integer", "example": 1 } } } }, "private_orders_userId__renamed": { "name": "renamed", "title": "Renamed", "summary": "Renamed", "payload": { "type": "object", "required": [ "order" ], "properties": { "order": { "type": "object", "required": [ "id", "user_id", "name", "template", "template_id", "task_type", "status", "price_units", "price_formatted", "currency_asset", "total_tokens", "total_duration_ms", "tokens_from_quota", "tokens_from_payg", "tokens_spent", "task_data", "result", "created_at", "updated_at", "files_expire_at", "files_expired", "retention", "eta_seconds", "eta_at", "completed_chunks", "total_chunks", "progress_percent", "stitching", "paragraphs" ], "properties": { "id": { "type": "string", "example": "01a12b4f-ddef-71a8-ae98-c8ec656c2886" }, "user_id": { "type": "integer", "example": 70 }, "name": { "type": [ "string", "null" ], "example": "example" }, "template": { "type": "object", "required": [ "id", "user_id", "slug", "name", "service_key", "service", "config", "is_public", "folder_id", "created_at", "updated_at" ], "properties": { "id": { "type": "string", "example": "01a12b4f-dded-706a-91d6-0f86a632230d" }, "user_id": { "type": "integer", "example": 71 }, "slug": { "type": "string", "example": "a80eab29-6508-36cb-b8e8-3e85029e97b3" }, "name": { "type": "string", "example": "consequatur" }, "service_key": { "type": "string", "example": "example" }, "service": { "description": "May arrive as `null`." }, "config": { "type": "array", "items": { "type": "object" } }, "is_public": { "type": "boolean", "example": false }, "folder_id": { "description": "May arrive as `null`." }, "created_at": { "type": "string", "format": "date-time", "example": "2026-10-11T14:13:36+00:00" }, "updated_at": { "type": "string", "format": "date-time", "example": "2026-10-11T14:13:36+00:00" } } }, "template_id": { "type": "string", "example": "01a12b4f-dded-706a-91d6-0f86a632230d" }, "task_type": { "type": "string", "enum": [ "tts", "image", "txt2img", "remix", "image_edit", "voice_clone", "sfx", "music", "voice_search" ], "example": "tts" }, "status": { "type": "string", "enum": [ "created", "pending", "in_progress", "completed", "result_delivered", "failed", "compensated", "cancelled", "partially_completed" ], "example": "created" }, "price_units": { "type": "number", "example": 97.05 }, "price_formatted": { "type": "number", "example": 0.97 }, "currency_asset": { "type": "object", "required": [ "id", "code", "kind", "precision", "name", "deleted_at", "created_at", "updated_at" ], "properties": { "id": { "description": "May arrive as `null`." }, "code": { "type": "string", "example": "LUMC" }, "kind": { "description": "May arrive as `null`." }, "precision": { "type": "integer", "example": 2 }, "name": { "description": "May arrive as `null`." }, "deleted_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } } }, "total_tokens": { "description": "May arrive as `null`." }, "total_duration_ms": { "description": "May arrive as `null`." }, "tokens_from_quota": { "description": "May arrive as `null`." }, "tokens_from_payg": { "description": "May arrive as `null`." }, "tokens_spent": { "description": "May arrive as `null`." }, "task_data": { "description": "May arrive as `null`." }, "result": { "description": "May arrive as `null`." }, "created_at": { "type": "string", "format": "date-time", "example": "2026-10-11T14:13:36+00:00" }, "updated_at": { "type": "string", "format": "date-time", "example": "2026-10-11T14:13:36+00:00" }, "files_expire_at": { "type": [ "string", "null" ], "format": "date-time" }, "files_expired": { "type": "boolean", "example": false }, "retention": { "type": "object", "required": [ "chunks", "files" ], "properties": { "chunks": { "type": "object", "required": [ "expires_at", "expired", "expires_early", "reason" ], "properties": { "expires_at": { "type": [ "string", "null" ], "format": "date-time" }, "expired": { "type": "boolean", "example": false }, "expires_early": { "type": "boolean", "example": false }, "reason": { "description": "May arrive as `null`." } } }, "files": { "type": "object", "required": [ "expires_at", "expired" ], "properties": { "expires_at": { "type": [ "string", "null" ], "format": "date-time" }, "expired": { "type": "boolean", "example": false } } } } }, "eta_seconds": { "description": "May arrive as `null`." }, "eta_at": { "type": [ "string", "null" ], "format": "date-time" }, "completed_chunks": { "description": "May arrive as `null`." }, "total_chunks": { "description": "May arrive as `null`." }, "progress_percent": { "description": "May arrive as `null`." }, "stitching": { "type": "boolean", "example": false }, "paragraphs": { "description": "May arrive as `null`." } } } } } }, "private_orders_userId__status_changed": { "name": "status.changed", "title": "Status changed", "summary": "The order changed status.", "payload": { "type": "object", "required": [ "order", "items_summary", "previous_status", "new_status" ], "properties": { "order": { "type": "object", "description": "A snapshot of the order without the chunk list — per-chunk changes arrive as separate `item.status.changed` events." }, "items_summary": { "type": "object", "description": "A summary of the order's chunks instead of the full list.", "required": [ "total", "by_status" ], "properties": { "total": { "type": "integer", "example": 12 }, "by_status": { "type": "object", "description": "How many chunks are in each status: `pending`, `processing`, `completed`, `failed`, `policy_flagged`.", "additionalProperties": { "type": "integer" }, "example": { "completed": 10, "failed": 2 } } } }, "previous_status": { "type": "string", "enum": [ "created", "pending", "in_progress", "completed", "result_delivered", "failed", "compensated", "cancelled", "partially_completed" ] }, "new_status": { "type": "string", "enum": [ "created", "pending", "in_progress", "completed", "result_delivered", "failed", "compensated", "cancelled", "partially_completed" ] } } } }, "private_orders_userId__archive_ready": { "name": "archive.ready", "title": "Archive ready", "summary": "Archive ready", "payload": { "type": "object", "description": "The ZIP archive is assembled and ready to download. Sent only for large orders built in the background.", "required": [ "order_id", "archive_id", "url", "expires_at" ], "properties": { "order_id": { "type": "string", "format": "uuid", "example": "019bb198-78f5-7082-8550-fee362917f2e" }, "archive_id": { "type": "string", "format": "uuid", "example": "019bb1a0-2c41-71f2-9f0b-6a3d0e8c4b17" }, "url": { "type": "string", "format": "uri", "description": "A ready-to-use ZIP link. Fetch it with a plain `GET`, no authorization headers, from storage rather than the API.", "example": "https://s3.example.com/archives/1/019bb1a0.zip?X-Amz-Signature=..." }, "size": { "type": "integer", "nullable": true, "description": "Archive size in bytes; `null` when storage did not report it.", "example": 104857600 }, "expires_at": { "type": "string", "format": "date-time", "description": "When the link stops working (ISO 8601) — no later than a day after it was built. Request the archive again afterwards.", "example": "2026-07-30T12:00:00+00:00" } } } }, "private_orders_userId__item_status_changed": { "name": "item.status.changed", "title": "Item status changed", "summary": "An order chunk changed status.", "payload": { "type": "object", "required": [ "item", "previous_status", "new_status" ], "properties": { "item": { "type": "object", "description": "The chunk index, its status, the result file path and the audio duration.", "properties": { "id": { "type": "string", "format": "uuid" }, "chunk_index": { "type": "integer", "nullable": true, "example": 3 }, "status": { "type": "string", "enum": [ "pending", "processing", "completed", "failed", "policy_flagged" ] }, "result_file": { "type": "object", "nullable": true }, "duration_ms": { "type": "integer", "nullable": true, "example": 12480 } } }, "previous_status": { "type": "string" }, "new_status": { "type": "string" }, "completed_chunks": { "type": "integer", "example": 3 }, "total_chunks": { "type": "integer", "example": 7 }, "progress_percent": { "type": "integer", "minimum": 0, "maximum": 100, "example": 43 }, "stitching": { "type": "boolean", "example": false, "description": "Whether the order's audio is being stitched. The last finished chunk of a multi-chunk order means stitching has started, not that the order is done: while `true` the result is not final." } } } }, "private_orders_userId__policy_cooldown_cleared": { "name": "policy_cooldown.cleared", "title": "Policy cooldown cleared", "summary": "Policy cooldown cleared", "payload": { "type": "object", "required": [ "was_blocked", "strikes", "level" ], "properties": { "was_blocked": { "type": "boolean", "example": true }, "strikes": { "type": "integer", "example": 0 }, "level": { "type": "integer", "example": 0 } } } }, "private_orders_userId__archive_failed": { "name": "archive.failed", "title": "Archive failed", "summary": "Archive failed", "payload": { "type": "object", "description": "Background ZIP assembly failed. This event is terminal: neither `progress` nor `ready` will arrive for that `archive_id` again, so dismiss the progress indicator on it — otherwise it stays on screen forever.", "required": [ "order_id", "archive_id", "reason" ], "properties": { "order_id": { "type": "string", "format": "uuid", "example": "019bb198-78f5-7082-8550-fee362917f2e" }, "archive_id": { "type": "string", "format": "uuid", "example": "019bb1a0-2c41-71f2-9f0b-6a3d0e8c4b17" }, "reason": { "type": "string", "enum": [ "order_not_found", "build_failed" ], "description": "A machine-readable reason code — pick the user-facing wording on your side.", "example": "build_failed" } } } }, "private_orders_userId__stitch_changed": { "name": "stitch.changed", "title": "Stitch changed", "summary": "Stitch changed", "payload": { "type": "object", "required": [ "order_id", "order_status", "stitching", "stitch" ], "properties": { "order_id": { "type": "string", "example": "01a12b4f-d2ba-70ef-b1a8-14aff97d1da2" }, "order_status": { "type": "string", "example": "created" }, "stitching": { "type": "boolean", "example": false }, "stitch": { "type": "object", "required": [ "id", "status", "paragraph_index", "restitch" ], "properties": { "id": { "type": "string", "example": "01a12b4f-d2bc-7117-83c6-a16f11eac8f4" }, "status": { "type": "string", "example": "pending" }, "paragraph_index": { "description": "May arrive as `null`." }, "restitch": { "type": "boolean", "example": false } } } } } }, "private_orders_userId__archive_progress": { "name": "archive.progress", "title": "Archive progress", "summary": "Archive progress", "payload": { "type": "object", "description": "Progress of a background ZIP assembly. Sent only for large orders (`mode=job`); a small archive is returned synchronously and produces no events. Values arrive in steps of roughly 20% — do not expect every percent; the last frame has `files_done` equal to `files_total`.", "required": [ "order_id", "archive_id", "percent", "files_done", "files_total" ], "properties": { "order_id": { "type": "string", "format": "uuid", "example": "019bb198-78f5-7082-8550-fee362917f2e" }, "archive_id": { "type": "string", "format": "uuid", "description": "The same `archive_id` returned when the archive was requested — match events to your UI card by it.", "example": "019bb1a0-2c41-71f2-9f0b-6a3d0e8c4b17" }, "percent": { "type": "integer", "minimum": 0, "maximum": 100, "example": 40 }, "files_done": { "type": "integer", "example": 8 }, "files_total": { "type": "integer", "example": 20 } } } }, "private_order_task_orderId__paragraph_regenerate_completed": { "name": "paragraph_regenerate.completed", "title": "Paragraph regenerate completed", "summary": "Paragraph regenerate completed", "payload": { "type": "object", "required": [ "order_id", "paragraph_index", "created_count", "failed_count" ], "properties": { "order_id": { "type": "string", "example": "01a0d8c6-86d3-70b5-a86e-5a12b1d860df" }, "paragraph_index": { "type": "integer", "example": 1 }, "created_count": { "type": "integer", "example": 1 }, "failed_count": { "type": "integer", "example": 1 } } } }, "private_order_task_orderId__voice_search_queue_updated": { "name": "voice_search.queue.updated", "title": "Voice search queue updated", "summary": "Voice search queue updated", "payload": { "type": "object", "required": [ "order_id", "queue_position", "queue_wait_seconds" ], "properties": { "order_id": { "type": "string", "example": "example" }, "queue_position": { "type": "integer", "example": 1 }, "queue_wait_seconds": { "type": [ "integer", "null" ], "example": 1 } } } }, "private_order_task_orderId__bulk_retry_completed": { "name": "bulk_retry.completed", "title": "Bulk retry completed", "summary": "Bulk retry completed", "payload": { "type": "object", "required": [ "order_id", "created_count", "failed_count" ], "properties": { "order_id": { "type": "string", "example": "01a0d8c6-86b5-706a-958a-a626ddb3ba3d" }, "created_count": { "type": "integer", "example": 1 }, "failed_count": { "type": "integer", "example": 1 } } } }, "private_order_task_orderId__renamed": { "name": "renamed", "title": "Renamed", "summary": "Renamed", "payload": { "type": "object", "required": [ "order" ], "properties": { "order": { "type": "object", "required": [ "id", "user_id", "name", "template", "template_id", "task_type", "status", "price_units", "price_formatted", "currency_asset", "total_tokens", "total_duration_ms", "tokens_from_quota", "tokens_from_payg", "tokens_spent", "task_data", "result", "created_at", "updated_at", "files_expire_at", "files_expired", "retention", "eta_seconds", "eta_at", "completed_chunks", "total_chunks", "progress_percent", "stitching", "paragraphs" ], "properties": { "id": { "type": "string", "example": "01a12b4f-ddef-71a8-ae98-c8ec656c2886" }, "user_id": { "type": "integer", "example": 70 }, "name": { "type": [ "string", "null" ], "example": "example" }, "template": { "type": "object", "required": [ "id", "user_id", "slug", "name", "service_key", "service", "config", "is_public", "folder_id", "created_at", "updated_at" ], "properties": { "id": { "type": "string", "example": "01a12b4f-dded-706a-91d6-0f86a632230d" }, "user_id": { "type": "integer", "example": 71 }, "slug": { "type": "string", "example": "a80eab29-6508-36cb-b8e8-3e85029e97b3" }, "name": { "type": "string", "example": "consequatur" }, "service_key": { "type": "string", "example": "example" }, "service": { "description": "May arrive as `null`." }, "config": { "type": "array", "items": { "type": "object" } }, "is_public": { "type": "boolean", "example": false }, "folder_id": { "description": "May arrive as `null`." }, "created_at": { "type": "string", "format": "date-time", "example": "2026-10-11T14:13:36+00:00" }, "updated_at": { "type": "string", "format": "date-time", "example": "2026-10-11T14:13:36+00:00" } } }, "template_id": { "type": "string", "example": "01a12b4f-dded-706a-91d6-0f86a632230d" }, "task_type": { "type": "string", "enum": [ "tts", "image", "txt2img", "remix", "image_edit", "voice_clone", "sfx", "music", "voice_search" ], "example": "tts" }, "status": { "type": "string", "enum": [ "created", "pending", "in_progress", "completed", "result_delivered", "failed", "compensated", "cancelled", "partially_completed" ], "example": "created" }, "price_units": { "type": "number", "example": 97.05 }, "price_formatted": { "type": "number", "example": 0.97 }, "currency_asset": { "type": "object", "required": [ "id", "code", "kind", "precision", "name", "deleted_at", "created_at", "updated_at" ], "properties": { "id": { "description": "May arrive as `null`." }, "code": { "type": "string", "example": "LUMC" }, "kind": { "description": "May arrive as `null`." }, "precision": { "type": "integer", "example": 2 }, "name": { "description": "May arrive as `null`." }, "deleted_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } } }, "total_tokens": { "description": "May arrive as `null`." }, "total_duration_ms": { "description": "May arrive as `null`." }, "tokens_from_quota": { "description": "May arrive as `null`." }, "tokens_from_payg": { "description": "May arrive as `null`." }, "tokens_spent": { "description": "May arrive as `null`." }, "task_data": { "description": "May arrive as `null`." }, "result": { "description": "May arrive as `null`." }, "created_at": { "type": "string", "format": "date-time", "example": "2026-10-11T14:13:36+00:00" }, "updated_at": { "type": "string", "format": "date-time", "example": "2026-10-11T14:13:36+00:00" }, "files_expire_at": { "type": [ "string", "null" ], "format": "date-time" }, "files_expired": { "type": "boolean", "example": false }, "retention": { "type": "object", "required": [ "chunks", "files" ], "properties": { "chunks": { "type": "object", "required": [ "expires_at", "expired", "expires_early", "reason" ], "properties": { "expires_at": { "type": [ "string", "null" ], "format": "date-time" }, "expired": { "type": "boolean", "example": false }, "expires_early": { "type": "boolean", "example": false }, "reason": { "description": "May arrive as `null`." } } }, "files": { "type": "object", "required": [ "expires_at", "expired" ], "properties": { "expires_at": { "type": [ "string", "null" ], "format": "date-time" }, "expired": { "type": "boolean", "example": false } } } } }, "eta_seconds": { "description": "May arrive as `null`." }, "eta_at": { "type": [ "string", "null" ], "format": "date-time" }, "completed_chunks": { "description": "May arrive as `null`." }, "total_chunks": { "description": "May arrive as `null`." }, "progress_percent": { "description": "May arrive as `null`." }, "stitching": { "type": "boolean", "example": false }, "paragraphs": { "description": "May arrive as `null`." } } } } } }, "private_order_task_orderId__status_changed": { "name": "status.changed", "title": "Status changed", "summary": "The order changed status.", "payload": { "type": "object", "required": [ "order", "items_summary", "previous_status", "new_status" ], "properties": { "order": { "type": "object", "description": "A snapshot of the order without the chunk list — per-chunk changes arrive as separate `item.status.changed` events." }, "items_summary": { "type": "object", "description": "A summary of the order's chunks instead of the full list.", "required": [ "total", "by_status" ], "properties": { "total": { "type": "integer", "example": 12 }, "by_status": { "type": "object", "description": "How many chunks are in each status: `pending`, `processing`, `completed`, `failed`, `policy_flagged`.", "additionalProperties": { "type": "integer" }, "example": { "completed": 10, "failed": 2 } } } }, "previous_status": { "type": "string", "enum": [ "created", "pending", "in_progress", "completed", "result_delivered", "failed", "compensated", "cancelled", "partially_completed" ] }, "new_status": { "type": "string", "enum": [ "created", "pending", "in_progress", "completed", "result_delivered", "failed", "compensated", "cancelled", "partially_completed" ] } } } }, "private_order_task_orderId__item_status_changed": { "name": "item.status.changed", "title": "Item status changed", "summary": "An order chunk changed status.", "payload": { "type": "object", "required": [ "item", "previous_status", "new_status" ], "properties": { "item": { "type": "object", "description": "The chunk index, its status, the result file path and the audio duration.", "properties": { "id": { "type": "string", "format": "uuid" }, "chunk_index": { "type": "integer", "nullable": true, "example": 3 }, "status": { "type": "string", "enum": [ "pending", "processing", "completed", "failed", "policy_flagged" ] }, "result_file": { "type": "object", "nullable": true }, "duration_ms": { "type": "integer", "nullable": true, "example": 12480 } } }, "previous_status": { "type": "string" }, "new_status": { "type": "string" }, "completed_chunks": { "type": "integer", "example": 3 }, "total_chunks": { "type": "integer", "example": 7 }, "progress_percent": { "type": "integer", "minimum": 0, "maximum": 100, "example": 43 }, "stitching": { "type": "boolean", "example": false, "description": "Whether the order's audio is being stitched. The last finished chunk of a multi-chunk order means stitching has started, not that the order is done: while `true` the result is not final." } } } }, "private_order_task_orderId__stitch_changed": { "name": "stitch.changed", "title": "Stitch changed", "summary": "Stitch changed", "payload": { "type": "object", "required": [ "order_id", "order_status", "stitching", "stitch" ], "properties": { "order_id": { "type": "string", "example": "01a12b4f-d2ba-70ef-b1a8-14aff97d1da2" }, "order_status": { "type": "string", "example": "created" }, "stitching": { "type": "boolean", "example": false }, "stitch": { "type": "object", "required": [ "id", "status", "paragraph_index", "restitch" ], "properties": { "id": { "type": "string", "example": "01a12b4f-d2bc-7117-83c6-a16f11eac8f4" }, "status": { "type": "string", "example": "pending" }, "paragraph_index": { "description": "May arrive as `null`." }, "restitch": { "type": "boolean", "example": false } } } } } }, "private_order_task_orderId__progress": { "name": "progress", "title": "Progress", "summary": "Live progress of the order.", "payload": { "type": "object", "required": [ "task_id", "progress", "chunks_done", "chunks_total" ], "properties": { "task_id": { "type": "string", "format": "uuid", "description": "The order UUID — the same value as the channel's `{orderId}`." }, "progress": { "type": "number", "description": "Kept for compatibility and **does not reflect progress** — rely on the `progress` events of the orders channel, or on `eta_seconds`.", "example": 42.5 }, "chunks_done": { "type": "integer", "description": "Kept for compatibility and **does not reflect how many parts are done** — count completion from `item.status.changed` events." }, "chunks_total": { "type": "integer", "description": "Total number of parts in the order." }, "duration_seconds": { "type": "number", "description": "How many seconds the task has been running. This is elapsed time, not remaining." }, "eta_seconds": { "type": [ "integer", "null" ], "description": "Estimated time remaining, in seconds. Computed by the API from service statistics.", "example": 95 }, "eta_confidence": { "type": [ "string", "null" ], "enum": [ "high", "medium", "low", null ], "description": "How much to trust the estimate: `high` — statistics for chunks of the same size, `medium` — for the service overall, `low` — little data, so show it with a «≈»." }, "timestamp": { "type": "string", "format": "date-time" } } } }, "private_chunks_preview_userId__ready": { "name": "ready", "title": "Ready", "summary": "Ready", "payload": { "type": "object", "required": [ "status", "preview_id", "summary", "page" ], "description": "The async preview is ready — a limited notification: totals for the whole text (`summary`) and the first page's meta (`page`). The chunks themselves are not part of this event — fetch them separately via `GET /orders/chunks/preview/{previewId}?page=1`.", "properties": { "status": { "type": "string", "enum": [ "ready" ], "example": "ready" }, "preview_id": { "type": "string", "description": "A content-based preview id (sha256 of text+template+mode). Use it for pagination (`GET .../{previewId}`) and repeat preflight lookups.", "example": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2" }, "summary": { "type": "object", "description": "Totals for the whole text — not just the current page of chunks.", "properties": { "chunks_count": { "type": "integer", "example": 342 }, "total_effective_length": { "type": "integer", "description": "Total billable length across all chunks, in characters (pauses are excluded).", "example": 680000 }, "total_price_units": { "type": "integer", "example": 680000 }, "pause_count": { "type": "integer", "example": 12 }, "total_pause_seconds": { "type": "number", "example": 30 }, "caps_ok": { "type": "boolean", "example": true }, "caps_exceeded": { "type": "string", "nullable": true, "enum": [ "count", "single", "total", "chunks", null ], "example": null }, "paragraphs_count": { "type": "integer", "nullable": true, "description": "Number of paragraphs, or `null` outside paragraph mode.", "example": null }, "paragraphs": { "type": "array", "nullable": true, "description": "A per-paragraph aggregate. `null` means either \"the preview is not paragraph-mode\" or \"there are more paragraphs than the broadcast payload cap\" — in the second case `paragraphs_count` stays a number, and you fetch the full list via `GET /orders/chunks/preview/{previewId}`.", "items": { "type": "object", "properties": { "paragraph_index": { "type": "integer", "example": 0 }, "chunks_count": { "type": "integer", "example": 3 }, "first_chunk_index": { "type": "integer", "description": "The cross-text index of the paragraph's first chunk — use it to locate the paragraph within the paginated chunk list.", "example": 0 }, "text_length": { "type": "integer", "example": 2400 }, "effective_length": { "type": "integer", "example": 2380 }, "price_units": { "type": "integer", "example": 2380 } } } } } }, "page": { "type": "object", "description": "Meta for the first page of chunks. Fetch the chunks themselves with a separate paginated `GET` request keyed by `preview_id`.", "properties": { "current_page": { "type": "integer", "example": 1 }, "per_page": { "type": "integer", "example": 100 }, "total": { "type": "integer", "description": "Total chunks in the split (across all pages).", "example": 342 }, "has_more": { "type": "boolean", "example": true } } } } } }, "private_cartesia_voice_clones_userId__voice_clone_updated": { "name": "voice_clone.updated", "title": "Voice clone updated", "summary": "A Cartesia voice clone was created or changed status (`pending` → `cloning` → `ready` or `failed`; `archived` after deletion). `voice_id` appears only once the clone is `ready` — put it into `tts_settings.voice_id` of a Cartesia template.", "payload": { "type": "object", "required": [ "voice_clone" ], "properties": { "voice_clone": { "type": "object", "required": [ "id", "provider", "display_name", "status", "voice_id", "attempts", "error", "created_at" ], "properties": { "id": { "type": "string", "format": "uuid" }, "provider": { "type": "string", "enum": [ "cartesia" ] }, "display_name": { "type": "string" }, "language": { "type": "string", "nullable": true, "example": "ru" }, "description": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": [ "pending", "cloning", "ready", "failed", "archived", "banned" ], "description": "Clone status. `banned` — a moderator blocked the clone: it is not accepted for new orders and cannot be deleted; the reason is in `ban_reason`." }, "voice_id": { "type": "string", "nullable": true, "description": "The Cartesia voice id — the value for `tts_settings.voice_id` of a template. Present only once the clone is `ready`, otherwise `null`." }, "attempts": { "type": "integer", "example": 1 }, "error": { "type": "object", "nullable": true, "properties": { "reason": { "type": "string", "description": "processing_error, max_retries, network, timeout, dispatch_failed" }, "message": { "type": "string", "nullable": true } } }, "created_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": "string", "format": "date-time", "nullable": true }, "failed_at": { "type": "string", "format": "date-time", "nullable": true }, "banned_at": { "type": "string", "format": "date-time", "nullable": true }, "ban_reason": { "type": "string", "nullable": true, "description": "Why a moderator blocked the clone, or `null`." } } } } } }, "private_fishaudio_voice_clones_userId__voice_clone_updated": { "name": "voice_clone.updated", "title": "Voice clone updated", "summary": "A Fish Audio voice clone was created or changed status (`pending` → `cloning` → `ready` or `failed`; `archived` after deletion; `banned` — blocked by a moderator). `voice_id` appears only once the clone is `ready` — put it into `tts_settings.voice_id` of a Fish Audio template.", "payload": { "type": "object", "required": [ "voice_clone" ], "properties": { "voice_clone": { "type": "object", "required": [ "id", "provider", "display_name", "status", "voice_id", "attempts", "error", "created_at" ], "properties": { "id": { "type": "string", "format": "uuid" }, "provider": { "type": "string", "enum": [ "fishaudio" ] }, "display_name": { "type": "string" }, "language": { "type": "string", "nullable": true, "example": "ru" }, "description": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": [ "pending", "cloning", "ready", "failed", "archived", "banned" ], "description": "Clone status. `banned` — a moderator blocked the clone: it is not accepted for new orders and cannot be deleted; the reason is in `ban_reason`." }, "voice_id": { "type": "string", "nullable": true, "description": "The Fish Audio voice id (a 32-character hex string, not a UUID) — the value for `tts_settings.voice_id` of a template. Present only once the clone is `ready`, otherwise `null`." }, "attempts": { "type": "integer", "example": 1 }, "error": { "type": "object", "nullable": true, "properties": { "reason": { "type": "string", "description": "processing_error, max_retries, network, timeout, dispatch_failed, unbanned" }, "message": { "type": "string", "nullable": true } } }, "created_at": { "type": "string", "format": "date-time" }, "completed_at": { "type": "string", "format": "date-time", "nullable": true }, "failed_at": { "type": "string", "format": "date-time", "nullable": true }, "banned_at": { "type": "string", "format": "date-time", "nullable": true }, "ban_reason": { "type": "string", "nullable": true, "description": "Why a moderator blocked the clone, or `null`." } } } } } }, "private_giftcodes_userId__status_changed": { "name": "status.changed", "title": "Status changed", "summary": "A gift code changed status.", "payload": { "type": "object", "required": [ "gift_code" ], "properties": { "gift_code": { "type": "object", "required": [ "uuid", "code_masked", "nominal", "nominal_formatted", "source", "funding", "status", "activatable_at", "redeemed_at", "cancelled_at", "created_at", "currency_asset" ], "properties": { "uuid": { "type": "string", "example": "a2467160-ceab-4ab6-8095-7a0fafda7648" }, "code_masked": { "type": "string", "example": "LUM-****-****-SNKG" }, "nominal": { "type": "integer", "example": 10000000000 }, "nominal_formatted": { "type": "number", "example": 100000000 }, "source": { "type": "string", "enum": [ "purchase", "reseller" ], "example": "purchase" }, "funding": { "type": "string", "enum": [ "rub", "crypto", "mixed" ], "example": "crypto" }, "status": { "type": "string", "enum": [ "active", "refunding", "redeemed", "refunded", "cancelled", "annulled" ], "example": "active" }, "activatable_at": { "type": "string", "example": "2026-10-10T14:47:14+00:00" }, "redeemed_at": { "type": [ "string", "null" ], "example": "2026-10-10T14:48:14+00:00", "format": "date-time" }, "cancelled_at": { "type": [ "string", "null" ], "example": "2026-10-10T14:48:14+00:00", "format": "date-time" }, "created_at": { "type": "string", "example": "2026-10-10T14:48:14+00:00" }, "currency_asset": { "type": "object", "required": [ "code", "precision" ], "properties": { "code": { "type": "string", "example": "LUMC" }, "precision": { "type": "integer", "example": 2 } } } } } } } }, "private_giftcodes_userId__issued": { "name": "issued", "title": "Issued", "summary": "A batch of gift codes was issued: the batch summary, without code values.", "payload": { "type": "object", "required": [ "batch" ], "properties": { "batch": { "type": "object", "required": [ "uuid", "source", "codes_count", "nominal_total", "nominal_total_formatted", "created_at", "currency_asset" ], "properties": { "uuid": { "type": "string", "example": "0a926d68-e974-4220-aab2-7952b111f170" }, "source": { "type": "string", "enum": [ "purchase", "reseller" ], "example": "purchase" }, "codes_count": { "type": "integer", "example": 1 }, "nominal_total": { "type": "integer", "example": 0 }, "nominal_total_formatted": { "type": "number", "example": 0 }, "created_at": { "type": "string", "example": "2026-10-10T14:48:13+00:00" }, "currency_asset": { "type": "object", "required": [ "code", "precision" ], "properties": { "code": { "type": "string", "example": "LUMC" }, "precision": { "type": "integer", "example": 2 } } } } } } } }, "private_giftcodes_userId__reseller_application_status_changed": { "name": "reseller.application.status.changed", "title": "Reseller application status changed", "summary": "The status of the reseller application changed.", "payload": { "type": "object", "required": [ "application" ], "properties": { "application": { "type": "object", "required": [ "id", "status", "admin_comment", "reviewed_at", "created_at" ], "properties": { "id": { "type": "integer", "example": 14 }, "status": { "type": "string", "enum": [ "pending", "approved", "rejected", "withdrawn" ], "example": "pending" }, "admin_comment": { "type": [ "string", "null" ], "example": "example" }, "reviewed_at": { "type": [ "string", "null" ], "example": "2026-10-10T14:48:15+00:00", "format": "date-time" }, "created_at": { "type": "string", "example": "2026-10-10T14:48:15+00:00" } } } } } }, "private_giftcodes_userId__reseller_status_changed": { "name": "reseller.status.changed", "title": "Reseller status changed", "summary": "The reseller status changed.", "payload": { "type": "object", "required": [ "reseller" ], "properties": { "reseller": { "type": "object", "required": [ "id", "status", "discount_bps", "blocked_reason", "approved_at", "currency_asset" ], "properties": { "id": { "type": "integer", "example": 1 }, "status": { "type": "string", "enum": [ "active", "blocked", "revoked" ], "example": "active" }, "discount_bps": { "type": "integer", "example": 0 }, "blocked_reason": { "type": [ "string", "null" ], "example": "example" }, "approved_at": { "type": "string", "example": "2026-10-12T15:55:20+00:00" }, "currency_asset": { "type": "object", "required": [ "code", "precision" ], "properties": { "code": { "type": "string", "example": "LUMC" }, "precision": { "type": "integer", "example": 2 } } } } } } } } } } }