Get Style Agent Batch

Live report for a batch: status, per-status counts, and per-document workflow ids + status. Fetch a document’s full result by its workflow_id from GET /style-agent/workflows/{workflow_id}.

This report is the authoritative view of a batch’s progress and completion; the optional completion webhook is a best-effort notification on top of it.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

batch_idstringRequired

Query parameters

item_limitintegerOptional1-100Defaults to 100

item_offsetintegerOptional>=0Defaults to 0

Response

Successful Response

batch_idstring

statusenum

Lifecycle of a style-agent batch (see design-docs/style-agent-batch-checking.md).

A batch is running while any item is non-terminal; it becomes completed (and sealed) once every item reaches a terminal state.

Allowed values:

sealedboolean

created_atdatetime

updated_atdatetime

item_countinteger

countsobject

itemslist of objects

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error