Sign in
styleAgent

Run Style Agent File

Run a Style Agent check on an uploaded document.

Accepts PDF, Word (.docx), HTML, DITA, Markdown, and plain-text files. The file is uploaded unchanged and its text extracted for you, so the check runs against the document as submitted.

Behaves like POST /style-agent/run otherwise: wait=true blocks for the result (201 Created), the default returns 202 Accepted with a workflow id to poll via GET /style-agent/workflows/{workflow_id}. A large file can take longer than the synchronous request window, so prefer polling for those.

Issue positions index the extracted text, not the bytes you uploaded; use each issue's context_surface to locate it in the original document.

post/style-agent/run-file

Query parameters

waitboolean

Headers

Authorizationstring required

Bearer authentication

Response

Successful Response

workflow_idstring required

Workflow ID for tracking

request_idstring nullable

Request tracking ID

status'running' | 'completed' | 'failed' | 'timed_out' | 'cancelled' required

Status of a workflow execution.

document_refstring nullable

Caller-provided document identifier.

check_type'interactive' | 'automated' | 'batch' | 'baseline'

How a content check should be counted.

The type fixes two things about a result: its priority (is someone waiting?) and its attribution (does it count as authoring activity for a person?).

  • INTERACTIVE: a writer checking content as they work — high priority, assigned.
  • AUTOMATED: a save/update check credited to the last editor — assigned.
  • BATCH: a bulk check of content you own — assigned to the content's author.
  • BASELINE: a check of content you do NOT own — a measurement, not authoring, so it is not assigned to anyone.
assignedboolean

Whether the check counts as authoring activity for an author.

batch_idstring nullable

Owning batch id (agbw_<nanoid>); null unless this is a batch check.

started_atstring date-time required

Workflow start time

completed_atstring date-time nullable

Workflow completion time

duration_secondsnumber double nullable

Execution duration

Changes