Skip to navigation

Append Style Agent Batch Items

Append up to 20 more documents to a batch that is still processing.

Rejected with 409 once the batch is sealed (1000 documents reached, or every document has finished) — create a new batch instead. Send an Idempotency-Key header to make retries safe: the same key + payload replays the original 202 instead of appending the documents again.

Authentication

AuthorizationBearer

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

Path parameters

batch_idstringRequired

Headers

Idempotency-Keystring or nullOptional1-255 characters

Optional client-generated key making this submission idempotent: a retry with the same key and payload returns the original accepted response instead of submitting the documents again. Reusing a key with a different payload returns 409.

Request

This endpoint expects an object.
itemslist of objectsRequired
defaultsobject or nullOptional

Optional per-batch defaults applied to any item that omits the field.

Response

Documents appended
batch_idstring
segment_workflow_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:
item_countinteger
created_atdatetime
itemslist of objects

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
413
Content Too Large Error
422
Unprocessable Entity Error
500
Internal Server Error