Skip to content

Process next batch​

POST
/v1/projects/{id}/process

Kick off the next batch of pages — this is the normal way to move a book forward. It checks the wallet up front (an unaffordable batch returns 402), then returns 202 with a jobId right away; poll GET /jobs/{jobId} or GET /projects/{id}/status to watch it finish. A book translates in escalating batches (1 page, then 5, then 25, then 100, then the rest), so you'll call this again after each one completes.

Authorizations​

Bearer

JWT bearer token from POST /v1/auth/login.

Type
HTTP (bearer)
or
ApiKey

Scoped API key for non-interactive clients (issued by PBI #1426).

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Type
string
Required
Format
"uuid"

Responses​

Accepted

application/json

202 body for POST /projects/{id}/process and POST /projects/{id}/retry: the
background job that was enqueued (or the existing in-flight one, under the single-in-flight guard).

Poll this id via GET /jobs/{jobId} to watch the batch finish.

Format"uuid"

The job's lifecycle status at the moment it was returned (e.g. Queued).

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI