Wraps

Create a full print wrap for a cover (async)

Generates back-cover artwork from an existing cover, extends the cover art out to the full front print panel, lays the supplied text out on the back, and composites a print-ready wrap: a full-resolution flat, a preview, and a KDP-ready PDF. Costs 2 credits for designStyle: "solid" and 4 for the AI styles; the whole amount is refunded if the job fails. The book's first wrap costs 0 credits 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 wrap back. Amazon KDP only. Call GET /api/v1/wraps/calculate first to confirm the geometry. Set the back-cover text and the spine lettering in any of the wrap editor's fonts with fontFamily.

post/api/v1/wraps

Request

Base URL: https://beyourcover.com
URL: https://beyourcover.com/api/v1/wraps
Auth: HTTP bearer

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

coverIdstring uuid required

Public id of the cover to use as the front panel.

trimWidthnumber required

Trim width in inches; must be a KDP trim size for the binding.

trimHeightnumber required

Trim height in inches.

pageCountinteger required

Interior page count. Drives spine width. Paperback 24-830, hardcover 76-550.

paperType'white' | 'cream' | 'premium_color' | 'standard_color' required

bindingType'paperback' | 'hardcover'

designStyle'solid' | 'textured' | 'continuation' | 'complementary'

solid fills the back with a flat colour (2 credits, no AI). textured echoes the front's motifs as a subtle pattern. continuation treats the front as the right half of a panorama. complementary designs new but cohesive artwork.

preset'standard' | 'blurb-only' | 'minimal'

Where the text goes. standard = tagline + blurb + author bio; blurb-only = one large text area; minimal = tagline only.

Font for the back-cover text and the spine lettering: one of the families the browser wrap editor offers. The text is auto-fitted in this font, so a wider face still fits its space.

solidColorstring

Hex colour for designStyle: "solid". Omitted, the dominant colour of the front cover is sampled.

spineColorstring

Hex spine colour. Omitted, it is sampled from the back artwork.

customInstructionsstring

Extra art direction appended to the back-cover prompt. Ignored for solid.

taglinestring

Short hook line, set in bold at the top of the back cover (presets standard and minimal).

blurbstring

Main back-cover description. Auto-fitted to its band; a warning is returned if it will not fit even at the minimum point size.

authorBiostring

Short author biography, set below the blurb (preset standard).

spineTitlestring

Spine lettering. Dropped with a warning when canHaveSpineText is false.

spineAuthorstring

Author name on the spine.

external_refstring

webhookUrlstring

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.

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.