Skip to navigation

Append Style Agent Batch Files

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

The file-upload form of POST /style-agent/batch/{batch_id}/items; a batch may mix the two freely. 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.

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 a multipart form with multiple files.
file_uploadsfilesRequired

The documents to check, one file per batch item. Text (.txt), Markdown (.md), HTML (.html, .htm), XML including DITA (.xml, .dita), Word (.docx), and PDF (.pdf) files are accepted. Content is analyzed in the format it is detected as, whatever the extension: a .txt file that contains HTML is checked as HTML. For plain-text, HTML, and XML files, issue positions are offsets into the text of the file you uploaded, counted in UTF-16 code units. Size limits apply per file and to the request as a whole; exceeding either returns 413 naming the limit.

itemsstring or nullOptional

Optional JSON array of per-item metadata, positionally aligned with the uploaded files: entry i describes file i. Each entry accepts the same fields as a text batch item minus ‘text’. Omit it (or send it empty) to check every file using only the batch defaults. When present, its length must equal the number of uploaded files.

defaultsstring or nullOptional

Optional JSON object of 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