v1

latestOpenAPI 3.1.02026-08-06387578.8 KB

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}.

post/style-agent/run

Query parameters

waitboolean

Headers

Authorizationstring required

Bearer authentication

Request body

textstring required

Document text to analyze.

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.

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.

started_atstring date-time required

Workflow start time

completed_atstring date-time nullable

Workflow completion time

duration_secondsnumber double nullable

Execution duration