Covers

Generate a square audiobook version of a cover (async)

Produces the audiobook_preview asset from the cover's preview image. Costs 1 credit, or 0 for the book's first audiobook cover when its marketing kit was opened in the app this billing period: the 202 then says credits_reserved: 0 and included_format: true, and a failed job does not give that included render back. Returns 409 asset_already_exists when the cover already has the asset, unless the body sends regenerate: true. The request body is optional (a missing/invalid JSON body is treated as {}).

post/api/v1/covers/{coverId}/audiobook-cover

Request

  • Base URL: https://beyourcover.com
  • URL: https://beyourcover.com/api/v1/covers/{coverId}/audiobook-cover
  • Auth: HTTP bearer

Path parameters

coverIdstring uuid required

The cover's public id (UUID) as returned in job results (covers[].coverId).

Headers

Idempotency-Keystring

Optional idempotency key. If a resource/job was already created with the same key (scoped to the API key for jobs, to the user for books), the endpoint returns 200 with the existing resource instead of creating a duplicate. Concurrent duplicates are also collapsed via a unique-constraint retry.

Request body

regenerateboolean

Set true to replace an existing audiobook_preview asset with a new run, as the app does. Charged as a new run: 1 credit, or 0 only when the book's included render is still unused. Clears the old audiobook_full upscale. Without it, an existing asset returns 409 asset_already_exists.

external_refstring

Optional caller-supplied reference. (Length/type limits are not enforced on this endpoint in code.)

webhookUrlstring

Optional per-job webhook URL. (Length/type limits are not enforced on this endpoint in code.)

Response

Idempotent replay of an existing job with the same Idempotency-Key.

jobIdstring uuid required
status'queued' | 'processing' | 'completed' | 'failed' required

Current status of the previously created job.

operation'generate' | 'variation' | 'edit_image' | 'upscale' | 'audiobook_cover' | 'remove_text' | 'generate_reference' | 'wrap' | 'wrap_extend_front' required
credits_reservedinteger

What the ORIGINAL job reserved. Returned by the variations, edit-image, upscale, audiobook-cover, remove-text, wraps and extend-front endpoints when the job recorded it.

included_formatboolean

true when the book's marketing kit paid for the ORIGINAL job instead of credits. Returned by the edit-image, upscale, audiobook-cover, remove-text, wraps and extend-front endpoints.

external_refstring nullable required

The external_ref stored on the ORIGINAL job.

created_atstring date-time required
poll_urlstring required

Changes

No recorded changes to this operation across all 1 revision of this API.