Skip to content

Generate Preview

POST
/api/creative/bookmaker/books/{book_id}/preview

Generate SVG page previews and extract the content-to-page manifest.

book_id
required
Book Id
string
>= 1 characters
project_id
required
Project Id
string
>= 1 characters

Successful Response

PreviewManifest

Page-to-content mapping extracted from a compiled book.

object
bookId
required
Bookid
string
pageCount
required
Pagecount
integer
compileTimeMs
required
Compiletimems
integer
entries
required
Entries
Array<object>
PageContentEntry

A content element mapped to a page in the compiled book.

object
nodeId
required
Nodeid
string
nodeType
required
Nodetype
string
title
required
Title
string
page
required
Page
integer

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object