VIvieneu
Public API v1

Start (or resume) rendering a book

Changed on

Queues every pending or failed chapter. Each chapter is billed in full to ONE plan — this key’s own when it can, otherwise another active plan of the account — so it is refused with 402 insufficient_tokens when the plans hold too little for the chapters in total, or when some chapter would find no plan able to pay it when its turn comes. Chapters then render one at a time, only while the GPU fleet is idle, each billed when it starts and refunded if it fails.

post/api/v1/audiobooks/{bookId}/start

Request

  • Base URL
    https://api.vieneu.io
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

bookIdstring required

Response

The book, queued.

idstring required
titlestring required
authorstring nullable required
status'draft' | 'queued' | 'rendering' | 'completed' | 'partial' | 'failed' | 'cancelled' required
narratorVoicestring required
waitingReasonstring nullable required

gpu_busy: books render only while the GPU fleet is idle; quota: the plan hit a limit, retried automatically; queue_full.

errorstring nullable required
otherBooksWaitingnumber nullable required

While started: how many other books are waiting too. Books take turns, a chapter each.

chapterCharsMaxnumber required

The longest chapter (in characters) the plan behind this key can render: a chapter is billed in one go, so it must fit the plan's daily or weekly token cap. 60,000 when the plan has no tighter cap.

createdAtstring date-time required
completedAtstring date-time nullable required

Example response

{
  "cast": [
    {
      "speaker": "Lan",
      "voiceId": "Ban Mai"
    }
  ]
}

Changes