Skip to content

List project jobs

GET
/v1/projects/{id}/jobs

Returns every processing job — past and present — that's run against this book.

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

When the job was enqueued (UTC).

Format"date-time"

Error text when JobStatus ProcessingJob.Status is JobStatus.Failed.

Stable identifier for this job (what the client polls).

Format"uuid"

Human-readable progress note (e.g. "processed 5 pages").

The owner the job belongs to (for access scoping). May be null single-user.

Format"uuid"

The project this job operates on.

Format"uuid"

Global dispatch order key — the durable, ordered queue position. The processor always runs the
JobStatus.Queued job with the smallest position next, so this is what lets
the in-process channel's otherwise-lost FIFO order survive a restart. Assigned monotonically at
creation (next-highest), so the default is plain enqueue order. A user reordering their own queue
only permutes the positions among their own pending jobs (see
Task<bool> IJobStore.ReorderQueuedAsync(Guid ownerId, IReadOnlyList<Guid> orderedJobIds, CancellationToken cancellationToken)), so it can never preempt another tenant.

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

Credit held on the owner's wallet for this batch, in USD (PBI #1479, token-economics spike D5) — the
committed never-exceed quote frozen at enqueue. 0 when nothing is held (an unlimited account, a
pre-#1479 row, or a hold already released).

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

Where the job is in its lifecycle.

Valid values"Queued""Running""Succeeded""Failed"

What the job does.

Valid values"ProcessNextBatch""RetryFailedPages"

When the job last changed state (UTC).

Format"date-time"

Playground

Server
Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI