Skip to navigation
Developer ReferenceAPI ReferenceStyle Agent

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.

Authentication

AuthorizationBearer

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

Query parameters

waitbooleanOptionalDefaults to false

Request

This endpoint expects an object.
textstringRequired1-100000 characters
Document text to analyze.
style_guide_idstring or nullOptional>=1 character

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 or nullOptional>=1 character

Language-service content profile ID for style checking.

domain_idslist of strings or nullOptional
Terminology domain IDs.
document_refstring or nullOptional1-512 characters

Caller-provided document identifier for tracking across scans.

urlstring or nullOptional>=1 character
Document URL.
document_namestring or nullOptional>=1 character
Document name or title.
webhook_urlstring or nullOptionalformat: "uri"1-2083 characters
Optional webhook URL for async result delivery.

Response

Successful Response
workflow_idstring
Workflow ID for tracking
statusenum
Workflow status
Allowed values:
started_atdatetime
Workflow start time
request_idstring or nullOptional
Request tracking ID
document_refstring or nullOptional

Caller-provided document identifier.

check_typeenumOptional

How this check is counted: ‘batch’ for a document checked as part of a batch, ‘interactive’ for a direct /run check.

Allowed values:
assignedbooleanOptionalDefaults to true
Whether the check counts as authoring activity for an author.
batch_idstring or nullOptional

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

resultobject or nullOptional

Execution result (if completed)

completed_atdatetime or nullOptional
Workflow completion time
duration_secondsdouble or nullOptional
Execution duration

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
500
Internal Server Error