Covers

Upscale a cover asset to print resolution (async)

Upscales preview -> full, audiobook_preview -> audiobook_full, or no_text -> no_text_full. FREE for every source asset, audiobook_preview included: consumes no credits (only the concurrency limit applies; there is no 402 on this endpoint). The web app's high-res downloads are free on Enterprise too. Returns 409 asset_already_exists if the target asset already exists, and 404 asset_not_available if the source asset has not been generated.

post/api/v1/covers/{coverId}/upscale

Request

  • Base URL: https://beyourcover.com
  • URL: https://beyourcover.com/api/v1/covers/{coverId}/upscale
  • 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

sourceAsset'preview' | 'audiobook_preview' | 'no_text' required

Which asset to upscale. preview produces the full asset; audiobook_preview produces audiobook_full; no_text produces no_text_full.

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.