Wraps

Get a wrap and re-sign its assets

Returns a stored wrap with fresh one-hour signed URLs. Wraps created in the browser wrap editor are readable here too, and vice versa; find a wrapId with GET /api/v1/wraps.

get/api/v1/wraps/{wrapId}

Request

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

Path parameters

wrapIdstring uuid required

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

Response

The wrap design and its assets.

wrapIdstring uuid required
bookIdstring uuid
designNamestring nullable

API for wraps created through this endpoint.

designStylestring nullable
printProvider'kdp' | 'bn'

kdp (Amazon KDP) or bn (Barnes & Noble). Wraps created through the API are always kdp; bn designs come from the browser wrap editor.

bindingTypestring nullable

paperback, hardcover, or dust-jacket (Barnes & Noble only).

trimWidthnumber
trimHeightnumber
pageCountinteger nullable

Null on a Barnes & Noble design: its spine width is entered by hand.

paperTypestring nullable

Null on a Barnes & Noble design.

spineWidthnumber
flapWidthnumber nullable

Width of each flap in inches on a Barnes & Noble dust jacket; null on every other format.

fullWidthInchesnumber
fullHeightInchesnumber
fontFamilystring nullable

The font of the tagline, blurb and author bio (else of the spine title), which a re-render keeps unless it names another. Null when the layout names none, in which case a preset sets Arimo. Blocks added by hand in the editor can use other fonts: see layout_state.

layout_stateobject nullable

Editor-schema layout: text blocks in percent-of-panel coordinates, image layers (imageBlocks, each on the back cover or, with panel: "spine", on the spine), spine styles, overlay settings.

created_atstring date-time
updated_atstring date-time

Changes

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