İçeriğe geç
Lumean API

Açıklamalar İngilizce

Bölümün arayüzü dilinize çevrildi, ancak işlem, şema ve hata açıklamaları yalnızca Rusça ve İngilizce mevcut — burada İngilizce sürüm gösteriliyor.

private-orders.{userId}

Events for every order of the account at once.

Kanal parametreleri

Değerlerinizi girin — kanal adında, aşağıdaki kodda ve konsolda görünürler. Hiçbir yere gönderilmez ve asla sayfa adresine yazılmazlar.

is the numeric id of the key owner, returned by GET /user.

Abone olunacak kanal adı

private-orders.{userId}

Adda hâlâ süslü parantez içinde yer tutucular var. Bu adla abone olamazsınız: sunucu kanalları tam ad eşleşmesiyle yetkilendirir.

import Pusher from 'pusher-js';

const pusher = new Pusher('7c4dd881d8116ac76fe89aff71d8c2ff', {
  wsHost: 'ws.lumean.app',
  wsPort: 443, wssPort: 443,
  forceTLS: true,
  enabledTransports: ['ws', 'wss'],
  cluster: '',
  channelAuthorization: {
    endpoint: 'https://api.lumean.app/api/public/broadcasting/auth',
    headers: { 'X-API-KEY': 'YOUR_API_KEY' },
  },
});

const channel = pusher.subscribe('private-orders.{userId}');
channel.bind('policy_cooldown.applied', (data) => {
  console.log(data);
});

Payload örneği

bağlı değil

Kanal: private-orders.{userId}

Bu, spesifikasyondan bir örnektir. Bağlantı yok ve taklit de edilmiyor: gerçekten abone olmak için API anahtarınız gerekir.

orders.read izni olan bir anahtar gerekir

.policy_cooldown.applied

{
  "reason": "policy_cooldown_active",
  "minutes": 1,
  "retry_after": 0,
  "retry_at": "1970-01-01T00:00:01+00:00",
  "level": 1,
  "threshold": 1
}

Kanal olayları: 14

Her olayın kendi çapa bağlantısı, açıklamalar ve enum değerleriyle tam bir payload tablosu ve örnek bir yapısı vardır. Adlar Laravel Echo gösteriminde, yani baştaki noktayla gösterilir.

.policy_cooldown.applied

Echo: .policy_cooldown.applied · pusher-js: policy_cooldown.applied

Payload alanları

reasonzorunlu
string
Örnek policy_cooldown_active
minuteszorunlu
integer
Örnek 1
retry_afterzorunlu
integer
Örnek 0
retry_atzorunlu
string
Örnek 1970-01-01T00:00:01+00:00
levelzorunlu
integer
Örnek 1
thresholdzorunlu
integer
Örnek 1

Payload örneği

{
  "reason": "policy_cooldown_active",
  "minutes": 1,
  "retry_after": 0,
  "retry_at": "1970-01-01T00:00:01+00:00",
  "level": 1,
  "threshold": 1
}

Değerler, spesifikasyonda bulunduğu yerde oradan alınır; geri kalanlar türe dayalı yer tutuculardır. Bu, olayın yapısıdır, gerçek bir olayın kaydı değildir.

.paragraph_regenerate.completed

Echo: .paragraph_regenerate.completed · pusher-js: paragraph_regenerate.completed

Payload alanları

order_idzorunlu
string
Örnek 01a0d8c6-86d3-70b5-a86e-5a12b1d860df
paragraph_indexzorunlu
integer
Örnek 1
created_countzorunlu
integer
Örnek 1
failed_countzorunlu
integer
Örnek 1

Payload örneği

{
  "order_id": "01a0d8c6-86d3-70b5-a86e-5a12b1d860df",
  "paragraph_index": 1,
  "created_count": 1,
  "failed_count": 1
}

Değerler, spesifikasyonda bulunduğu yerde oradan alınır; geri kalanlar türe dayalı yer tutuculardır. Bu, olayın yapısıdır, gerçek bir olayın kaydı değildir.

.created

Echo: .created · pusher-js: created

A new order was created.

Payload alanları

orderzorunlu

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

object
idisteğe bağlı
integer
Örnek 1024
uuidisteğe bağlı
string (uuid)
user_idisteğe bağlı
integer
Örnek 7
statusisteğe bağlı
Değerlercreatedqueuedprocessingcompletedfailedcancelled
string
Örnek created
task_typeisteğe bağlı
string | null
total_amountisteğe bağlı
number
Örnek 12.5
created_atisteğe bağlı
string (date-time)
templateisteğe bağlı
object
items_summaryzorunlu

A summary of the order's chunks instead of the full list.

object
totalzorunlu
integer
Örnek 12
by_statuszorunlu

How many chunks are in each status: pending, processing, completed, failed, policy_flagged.

object<string, integer>
Örnek {"pending":12}

Payload örneği

{
  "order": {
    "id": 1024,
    "uuid": "<uuid>",
    "user_id": 7,
    "status": "created",
    "task_type": "string",
    "total_amount": 12.5,
    "created_at": "<date-time>",
    "template": {}
  },
  "items_summary": {
    "total": 12,
    "by_status": {
      "pending": 12
    }
  }
}

Değerler, spesifikasyonda bulunduğu yerde oradan alınır; geri kalanlar türe dayalı yer tutuculardır. Bu, olayın yapısıdır, gerçek bir olayın kaydı değildir.

.progress

Echo: .progress · pusher-js: progress

The order's overall progress was updated.

Progress across the order's original chunks. Retries and regenerations are not counted.

Payload alanları

order_idzorunlu
string (uuid)
Örnek 019bb198-78f5-7082-8550-fee362917f2e
completedzorunlu
integer
Örnek 3
totalzorunlu
integer
Örnek 7
percentzorunlu
integer
Örnek 43

Payload örneği

{
  "order_id": "019bb198-78f5-7082-8550-fee362917f2e",
  "completed": 3,
  "total": 7,
  "percent": 43
}

Değerler, spesifikasyonda bulunduğu yerde oradan alınır; geri kalanlar türe dayalı yer tutuculardır. Bu, olayın yapısıdır, gerçek bir olayın kaydı değildir.

.voice_search.queue.updated

Echo: .voice_search.queue.updated · pusher-js: voice_search.queue.updated

Payload alanları

order_idzorunlu
string
Örnek example
queue_positionzorunlu
integer
Örnek 1
queue_wait_secondszorunlu
integer | null
Örnek 1

Payload örneği

{
  "order_id": "example",
  "queue_position": 1,
  "queue_wait_seconds": 1
}

Değerler, spesifikasyonda bulunduğu yerde oradan alınır; geri kalanlar türe dayalı yer tutuculardır. Bu, olayın yapısıdır, gerçek bir olayın kaydı değildir.

.bulk_retry.completed

Echo: .bulk_retry.completed · pusher-js: bulk_retry.completed

Payload alanları

order_idzorunlu
string
Örnek 01a0d8c6-86b5-706a-958a-a626ddb3ba3d
created_countzorunlu
integer
Örnek 1
failed_countzorunlu
integer
Örnek 1

Payload örneği

{
  "order_id": "01a0d8c6-86b5-706a-958a-a626ddb3ba3d",
  "created_count": 1,
  "failed_count": 1
}

Değerler, spesifikasyonda bulunduğu yerde oradan alınır; geri kalanlar türe dayalı yer tutuculardır. Bu, olayın yapısıdır, gerçek bir olayın kaydı değildir.

.renamed

Echo: .renamed · pusher-js: renamed

Payload alanları

orderzorunlu
object
idzorunlu
string
Örnek 01a12b4f-ddef-71a8-ae98-c8ec656c2886
user_idzorunlu
integer
Örnek 70
namezorunlu
string | null
Örnek example
templatezorunlu
object
idzorunlu
string
Örnek 01a12b4f-dded-706a-91d6-0f86a632230d
user_idzorunlu
integer
Örnek 71
slugzorunlu
string
Örnek a80eab29-6508-36cb-b8e8-3e85029e97b3
namezorunlu
string
Örnek consequatur
service_keyzorunlu
string
Örnek example
servicezorunlu

May arrive as null.

unknown
configzorunlu
array<object>
is_publiczorunlu
boolean
Örnek false
folder_idzorunlu

May arrive as null.

unknown
created_atzorunlu
string (date-time)
Örnek 2026-10-11T14:13:36+00:00
updated_atzorunlu
string (date-time)
Örnek 2026-10-11T14:13:36+00:00
template_idzorunlu
string
Örnek 01a12b4f-dded-706a-91d6-0f86a632230d
task_typezorunlu
Değerlerttsimagetxt2imgremiximage_editvoice_clonesfxmusicvoice_search
string
Örnek tts
statuszorunlu
Değerlercreatedpendingin_progresscompletedresult_deliveredfailedcompensatedcancelledpartially_completed
string
Örnek created
price_unitszorunlu
number
Örnek 97.05
price_formattedzorunlu
number
Örnek 0.97
currency_assetzorunlu
object
idzorunlu

May arrive as null.

unknown
codezorunlu
string
Örnek LUMC
kindzorunlu

May arrive as null.

unknown
precisionzorunlu
integer
Örnek 2
namezorunlu

May arrive as null.

unknown
deleted_atzorunlu
string (date-time) | null
created_atzorunlu
string (date-time) | null
updated_atzorunlu
string (date-time) | null
total_tokenszorunlu

May arrive as null.

unknown
total_duration_mszorunlu

May arrive as null.

unknown
tokens_from_quotazorunlu

May arrive as null.

unknown
tokens_from_paygzorunlu

May arrive as null.

unknown
tokens_spentzorunlu

May arrive as null.

unknown
task_datazorunlu

May arrive as null.

unknown
resultzorunlu

May arrive as null.

unknown
created_atzorunlu
string (date-time)
Örnek 2026-10-11T14:13:36+00:00
updated_atzorunlu
string (date-time)
Örnek 2026-10-11T14:13:36+00:00
files_expire_atzorunlu
string (date-time) | null
files_expiredzorunlu
boolean
Örnek false
retentionzorunlu
object
chunkszorunlu
object
expires_atzorunlu
string (date-time) | null
expiredzorunlu
boolean
Örnek false
expires_earlyzorunlu
boolean
Örnek false
reasonzorunlu

May arrive as null.

unknown
fileszorunlu
object
expires_atzorunlu
string (date-time) | null
expiredzorunlu
boolean
Örnek false
eta_secondszorunlu

May arrive as null.

unknown
eta_atzorunlu
string (date-time) | null
completed_chunkszorunlu

May arrive as null.

unknown
total_chunkszorunlu

May arrive as null.

unknown
progress_percentzorunlu

May arrive as null.

unknown
stitchingzorunlu
boolean
Örnek false
paragraphszorunlu

May arrive as null.

unknown

Payload örneği

{
  "order": {
    "id": "01a12b4f-ddef-71a8-ae98-c8ec656c2886",
    "user_id": 70,
    "name": "example",
    "template": {
      "id": "01a12b4f-dded-706a-91d6-0f86a632230d",
      "user_id": 71,
      "slug": "a80eab29-6508-36cb-b8e8-3e85029e97b3",
      "name": "consequatur",
      "service_key": "example",
      "service": "string",
      "config": [],
      "is_public": false,
      "folder_id": "string",
      "created_at": "2026-10-11T14:13:36+00:00",
      "updated_at": "2026-10-11T14:13:36+00:00"
    },
    "template_id": "01a12b4f-dded-706a-91d6-0f86a632230d",
    "task_type": "tts",
    "status": "created",
    "price_units": 97.05,
    "price_formatted": 0.97,
    "currency_asset": {
      "id": "string",
      "code": "LUMC",
      "kind": "string",
      "precision": 2,
      "name": "string",
      "deleted_at": "<date-time>",
      "created_at": "<date-time>",
      "updated_at": "<date-time>"
    },
    "total_tokens": "string",
    "total_duration_ms": "string",
    "tokens_from_quota": "string",
    "tokens_from_payg": "string",
    "tokens_spent": "string",
    "task_data": "string",
    "result": "string",
    "created_at": "2026-10-11T14:13:36+00:00",
    "updated_at": "2026-10-11T14:13:36+00:00",
    "files_expire_at": "<date-time>",
    "files_expired": false,
    "retention": {
      "chunks": {
        "expires_at": "<date-time>",
        "expired": false,
        "expires_early": false,
        "reason": "string"
      },
      "files": {
        "expires_at": "<date-time>",
        "expired": false
      }
    },
    "eta_seconds": "string",
    "eta_at": "<date-time>",
    "completed_chunks": "string",
    "total_chunks": "string",
    "progress_percent": "string",
    "stitching": false,
    "paragraphs": "string"
  }
}

Değerler, spesifikasyonda bulunduğu yerde oradan alınır; geri kalanlar türe dayalı yer tutuculardır. Bu, olayın yapısıdır, gerçek bir olayın kaydı değildir.

.status.changed

Echo: .status.changed · pusher-js: status.changed

The order changed status.

Payload alanları

orderzorunlu

A snapshot of the order without the chunk list — per-chunk changes arrive as separate item.status.changed events.

object
items_summaryzorunlu

A summary of the order's chunks instead of the full list.

object
totalzorunlu
integer
Örnek 12
by_statuszorunlu

How many chunks are in each status: pending, processing, completed, failed, policy_flagged.

object<string, integer>
Örnek {"completed":10,"failed":2}
previous_statuszorunlu
Değerlercreatedpendingin_progresscompletedresult_deliveredfailedcompensatedcancelledpartially_completed
string
new_statuszorunlu
Değerlercreatedpendingin_progresscompletedresult_deliveredfailedcompensatedcancelledpartially_completed
string

Payload örneği

{
  "order": {},
  "items_summary": {
    "total": 12,
    "by_status": {
      "completed": 10,
      "failed": 2
    }
  },
  "previous_status": "created",
  "new_status": "created"
}

Değerler, spesifikasyonda bulunduğu yerde oradan alınır; geri kalanlar türe dayalı yer tutuculardır. Bu, olayın yapısıdır, gerçek bir olayın kaydı değildir.

.archive.ready

Echo: .archive.ready · pusher-js: archive.ready

The ZIP archive is assembled and ready to download. Sent only for large orders built in the background.

Payload alanları

order_idzorunlu
string (uuid)
Örnek 019bb198-78f5-7082-8550-fee362917f2e
archive_idzorunlu
string (uuid)
Örnek 019bb1a0-2c41-71f2-9f0b-6a3d0e8c4b17
urlzorunlu

A ready-to-use ZIP link. Fetch it with a plain GET, no authorization headers, from storage rather than the API.

string (uri)
Örnek https://s3.example.com/archives/1/019bb1a0.zip?X-Amz-Signature=...
sizeisteğe bağlı

Archive size in bytes; null when storage did not report it.

integer | null
Örnek 104857600
expires_atzorunlu

When the link stops working (ISO 8601) — no later than a day after it was built. Request the archive again afterwards.

string (date-time)
Örnek 2026-07-30T12:00:00+00:00

Payload örneği

{
  "order_id": "019bb198-78f5-7082-8550-fee362917f2e",
  "archive_id": "019bb1a0-2c41-71f2-9f0b-6a3d0e8c4b17",
  "url": "https://s3.example.com/archives/1/019bb1a0.zip?X-Amz-Signature=...",
  "size": 104857600,
  "expires_at": "2026-07-30T12:00:00+00:00"
}

Değerler, spesifikasyonda bulunduğu yerde oradan alınır; geri kalanlar türe dayalı yer tutuculardır. Bu, olayın yapısıdır, gerçek bir olayın kaydı değildir.

.item.status.changed

Echo: .item.status.changed · pusher-js: item.status.changed

An order chunk changed status.

Payload alanları

itemzorunlu

The chunk index, its status, the result file path and the audio duration.

object
idisteğe bağlı
string (uuid)
chunk_indexisteğe bağlı
integer | null
Örnek 3
statusisteğe bağlı
Değerlerpendingprocessingcompletedfailedpolicy_flagged
string
result_fileisteğe bağlı
object | null
duration_msisteğe bağlı
integer | null
Örnek 12480
previous_statuszorunlu
string
new_statuszorunlu
string
completed_chunksisteğe bağlı
integer
Örnek 3
total_chunksisteğe bağlı
integer
Örnek 7
progress_percentisteğe bağlı
integer
Örnek 43
stitchingisteğe bağlı

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.

boolean
Örnek false

Payload örneği

{
  "item": {
    "id": "<uuid>",
    "chunk_index": 3,
    "status": "pending",
    "result_file": {},
    "duration_ms": 12480
  },
  "previous_status": "string",
  "new_status": "string",
  "completed_chunks": 3,
  "total_chunks": 7,
  "progress_percent": 43,
  "stitching": false
}

Değerler, spesifikasyonda bulunduğu yerde oradan alınır; geri kalanlar türe dayalı yer tutuculardır. Bu, olayın yapısıdır, gerçek bir olayın kaydı değildir.

.policy_cooldown.cleared

Echo: .policy_cooldown.cleared · pusher-js: policy_cooldown.cleared

Payload alanları

was_blockedzorunlu
boolean
Örnek true
strikeszorunlu
integer
Örnek 0
levelzorunlu
integer
Örnek 0

Payload örneği

{
  "was_blocked": true,
  "strikes": 0,
  "level": 0
}

Değerler, spesifikasyonda bulunduğu yerde oradan alınır; geri kalanlar türe dayalı yer tutuculardır. Bu, olayın yapısıdır, gerçek bir olayın kaydı değildir.

.archive.failed

Echo: .archive.failed · pusher-js: archive.failed

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.

Payload alanları

order_idzorunlu
string (uuid)
Örnek 019bb198-78f5-7082-8550-fee362917f2e
archive_idzorunlu
string (uuid)
Örnek 019bb1a0-2c41-71f2-9f0b-6a3d0e8c4b17
reasonzorunlu

A machine-readable reason code — pick the user-facing wording on your side.

Değerlerorder_not_foundbuild_failed
string
Örnek build_failed

Payload örneği

{
  "order_id": "019bb198-78f5-7082-8550-fee362917f2e",
  "archive_id": "019bb1a0-2c41-71f2-9f0b-6a3d0e8c4b17",
  "reason": "build_failed"
}

Değerler, spesifikasyonda bulunduğu yerde oradan alınır; geri kalanlar türe dayalı yer tutuculardır. Bu, olayın yapısıdır, gerçek bir olayın kaydı değildir.

.stitch.changed

Echo: .stitch.changed · pusher-js: stitch.changed

Payload alanları

order_idzorunlu
string
Örnek 01a12b4f-d2ba-70ef-b1a8-14aff97d1da2
order_statuszorunlu
string
Örnek created
stitchingzorunlu
boolean
Örnek false
stitchzorunlu
object
idzorunlu
string
Örnek 01a12b4f-d2bc-7117-83c6-a16f11eac8f4
statuszorunlu
string
Örnek pending
paragraph_indexzorunlu

May arrive as null.

unknown
restitchzorunlu
boolean
Örnek false

Payload örneği

{
  "order_id": "01a12b4f-d2ba-70ef-b1a8-14aff97d1da2",
  "order_status": "created",
  "stitching": false,
  "stitch": {
    "id": "01a12b4f-d2bc-7117-83c6-a16f11eac8f4",
    "status": "pending",
    "paragraph_index": "string",
    "restitch": false
  }
}

Değerler, spesifikasyonda bulunduğu yerde oradan alınır; geri kalanlar türe dayalı yer tutuculardır. Bu, olayın yapısıdır, gerçek bir olayın kaydı değildir.

.archive.progress

Echo: .archive.progress · pusher-js: archive.progress

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.

Payload alanları

order_idzorunlu
string (uuid)
Örnek 019bb198-78f5-7082-8550-fee362917f2e
archive_idzorunlu

The same archive_id returned when the archive was requested — match events to your UI card by it.

string (uuid)
Örnek 019bb1a0-2c41-71f2-9f0b-6a3d0e8c4b17
percentzorunlu
integer
Örnek 40
files_donezorunlu
integer
Örnek 8
files_totalzorunlu
integer
Örnek 20

Payload örneği

{
  "order_id": "019bb198-78f5-7082-8550-fee362917f2e",
  "archive_id": "019bb1a0-2c41-71f2-9f0b-6a3d0e8c4b17",
  "percent": 40,
  "files_done": 8,
  "files_total": 20
}

Değerler, spesifikasyonda bulunduğu yerde oradan alınır; geri kalanlar türe dayalı yer tutuculardır. Bu, olayın yapısıdır, gerçek bir olayın kaydı değildir.

Tüm kanallar ve bağlantı parametreleri·POST /broadcasting/auth

Bu sayfayı yapay zekâya verin

.md sürümünü açllm.md

spesifikasyon 0.0.1