Skip to content

Get next batch quote

GET
/v1/projects/{id}/batch-quote

Before you call POST /process, check how many pages the next batch covers, what it's estimated to cost, and whether the wallet can cover it. Useful at every step of the 1 → 5 → 25 → 100 → rest batch ladder as the batches get bigger.

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

OK

application/json

A pre-flight quote for the next batch the project would run: how many pages, the estimated
cost (from the calibrated book estimator), and whether the owner's wallet can cover it. This is what
the UI shows before processing and at each step of the 1→5→25→100 approval ladder.

Whether the next batch is allowed to start: always true when Unlimited; otherwise
requires a positive balance and (once estimable) an estimate that does not exceed the balance.

The owner's current balance, for display alongside the estimate.

Format"double"
Pattern"^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"

The committed, never-exceed cost of the next batch — quoted at the tier-CEILING rate (PBI #1997,
spike #1956). This is the "$Y" figure the wallet affordability gate + hold are computed against, so the
user is never charged more than this. Equals ExpectedUsd when no GPU price table is
configured (ceiling == expected). Kept as EstimatedUsd because it has always been the gated number.

Format"double"
Pattern"^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"

The expected/typical cost of the next batch — the honest "about $X" headline at the expected rate
(PBI #1997). Shown alongside EstimatedUsd as "about $X · never more than $Y".

Default0
Format"double"
Pattern"^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"

False until at least one page has been measured — the first (calibration) batch runs without a
dollar estimate, after which every subsequent batch is estimable.

Pages the next batch would process (0 if none are pending).

Format"int32"
Pattern"^-?(?:0|[1-9]\\d*)$"

Human-readable explanation (calibration state, or why a batch is blocked).

Calibrated steady-state (expected) cost per page in USD (0 until calibrated).

Format"double"
Pattern"^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"

The project's resolved destination language (PBI #1451), so the viewer can show "translating into
<language>" alongside the quote. Defaults to en.

Default"en"

True for a whitelisted account (never charged, never blocked).

Playground

Server
Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI