Skip to content

Process next batch (sync)

POST
/v1/projects/{id}/process-next-batch

Run the next batch of pages right now and wait for the result in this response — kept for manual and admin use; most clients want the async POST /process below instead, which returns immediately. Checks the wallet first: an unaffordable batch returns 402 rather than running and leaving you with a bill you can't pay.

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

The outcome of a single Task<BatchRunResult> ITranslationPipeline.ProcessNextBatchAsync(Guid projectId, CancellationToken cancellationToken) run.

The batch size the policy granted for this run.

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

Pages in this run whose processing failed (and were marked PageStatus.Failed), in page
order. Empty on a clean run. A partial batch still parks its successful pages for review while these
stay failed and individually retryable via Task<BatchRunResult> ITranslationPipeline.RetryFailedPagesAsync(Guid projectId, CancellationToken cancellationToken).

Total measured GPU cost of this batch in USD (the sum of the pages' PageCostSample.CostUsd).
Zero when no cost collaborators are wired (the fake-adapter path). Billing debits this from the
owner's wallet after the batch settles — the pipeline only reports it, never charges for it.

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

The pages successfully processed in this run, in page order.

The project's status after the run: ProjectStatus.Processing while reachable work
remains, ProjectStatus.Complete when every included page is Approved, or
ProjectStatus.CompletedWithErrors (PBI #1537) when no reachable work remains but an
included page permanently exhausted its retry attempts.

Valid values"Created""Calibrating""Processing""PausedNeedsCredit""PausedNeedsCapacity""Complete""CompletedWithErrors""Failed""Cancelling""Cancelled"

The review package for each processed page, ready for the UI.

Playground

Server
Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI