Sign in
styleAgent

Run Style Agent

Run a Style Agent content check.

Submit document text to analyze it against your organization's style configuration. Set wait=true to block until the check completes and return the result (201 Created); the default (wait=false) returns 202 Accepted immediately with a workflow id to poll via GET /style-agent/workflows/{workflow_id}.

To check a PDF, Word, HTML, DITA, Markdown, or plain-text file, use POST /style-agent/run-file instead.

post/style-agent/run

Query parameters

waitboolean

Headers

Authorizationstring required

Bearer authentication

Request body

style_guide_idstring nullable

Style guide ID to check the document against. target_id is a deprecated alias for this field; send exactly one of the two names.

content_profile_idstring nullable

Language-service content profile ID for style checking.

domain_idsstring[] nullable

Terminology domain IDs.

document_refstring nullable

Caller-provided document identifier for tracking across scans.

urlstring nullable

Document URL.

document_namestring nullable

Document name or title.

webhook_urlstring uri nullable

Optional webhook URL for async result delivery.

textstring required

Document text to analyze.

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