VIvieneu
Public API v1

Cancel a book

Changed on

Chapters not started are dropped and never billed; a chapter already rendering finishes and is kept.

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

Request

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

Path parameters

bookIdstring required

Response

The cancelled book.

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