Skip to content

Batch Compile

POST
/api/creative/bookmaker/books/{book_id}/batch-compile

Compile a book for multiple platform presets in one request.

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

Request to compile a book for multiple platform presets.

object
presetIds
required
Presetids
Array<string>
Allowed values: kdp-paperback kdp-hardcover drivethrurpg ingram-spark lulu custom

Successful Response

BatchCompileResponse

Result of compiling a book across multiple platforms.

object
bookId
required
Bookid
string
results
Results
Array<object>
BatchCompileResult

Result of a single platform compilation within a batch.

object
presetId
required
Presetid
string
Allowed values: kdp-paperback kdp-hardcover drivethrurpg ingram-spark lulu custom
response
required
BookCompileResponse

Result of a book compilation.

object
bookId
required
Bookid
string
status
required
Status
string
Allowed values: draft compiling compiled error
outputPath
required
Outputpath
string
pageCount
required
Any of:
integer
compileTimeMs
required
Compiletimems
integer
errors
Errors
Array<string>

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