Skip to content
Ishvana Ishvana Docs

Compile Book

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

Trigger PDF compilation for a book. Requires Typst binary.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
book_id
required
Book Id
string
>= 1 characters

Query Parameters

Section titled “Query Parameters ”
project_id
required
Project Id
string
>= 1 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

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>

422

Section titled “422 ”

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