Wraps

Re-typeset an existing wrap (free, synchronous)

Re-lays the back-cover text on the artwork this wrap already has and returns fresh assets. No model runs, so it is free and returns 200 directly rather than a job to poll — fixing a typo should not cost a second wrap. Send only the fields you want to change: the stored layout is patched in place, nothing moves, and every field you omit keeps its current text. Send fontFamily to set the text in another of the editor's fonts. Send preset to lay the text out again with that preset. A wrap whose layout holds text blocks or images the preset does not own (one laid out in the browser wrap editor) is patched instead, and the response carries a preset_not_applied warning, because re-running the preset would delete them. Send a full layoutState to render a layout edited in the browser wrap editor. spineColor and, on a solid wrap, solidColor are free here too: a solid back panel is a flat fill, so changing its colour needs no model and never costs a second wrap. Works on every wrap of the account, including Amazon KDP and Barnes & Noble designs made in the browser wrap editor: the geometry comes from the wrap's own print setup (a Barnes & Noble spine entered by hand, a dust jacket's flaps).

post/api/v1/wraps/{wrapId}/render

Request

Base URL: https://beyourcover.com
URL: https://beyourcover.com/api/v1/wraps/{wrapId}/render
Auth: HTTP bearer

Path parameters

wrapIdstring uuid required

The wrap's id, returned as wrapId in the wrap job result.

Request body

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

Lays the text out again with this preset. Omit it to patch the stored layout in place. Not re-run on a layout with text blocks or images the preset does not own: that layout is patched, with a preset_not_applied warning. Ignored when layoutState is supplied. When it is omitted, only a wrap with no stored layout yet is laid out from scratch, with standard.

Sets the tagline, blurb, author bio and spine lettering in this font and re-fits them. Omitted, the wrap keeps its current font (fontFamily on GET /api/v1/wraps/{wrapId}). Text blocks the author added in the editor keep their own fonts. Ignored when layoutState is supplied: the layout carries its own fonts.

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.

spineColorstring

Hex spine colour. Omitted, the wrap's stored colour is kept.

solidColorstring

New hex colour for a solid back cover, e.g. #1A2B3C. Free, like the rest of this endpoint — a solid back panel is a flat fill, so repainting it runs no model — and it is persisted, so later renders keep it. Valid only on a wrap created with designStyle: solid; on a wrap whose back is AI artwork the colour comes from the art itself and this returns back_color_requires_solid_style.

layoutStateobject

A complete editor-schema layout (as returned in layout_state by GET /api/v1/wraps/{wrapId}). Takes precedence over the text fields and the preset. imageBlocks get the browser editor's checks: at most 5 image layers (back cover and spine together), else too_many_image_layers; each image path the stored layout does not already carry is moderated, else content_policy_violation. An image path outside this account is skipped with an image_block_not_rendered warning.

Response

Re-rendered assets and the layout report.

wrapIdstring uuid required

bookIdstring uuid

Changes

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