API ReferenceStyle Checks

Create Style Check

Start a style and brand check workflow. Returns a workflow ID to use for polling results.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects a multipart form containing a file.
file_uploadfileRequired

The document you’d like us to analyze. We accept text files (.txt), PDFs (.pdf), and Markdown files (.md). File size limit: 1.5MB. Encoding: UTF-8 (standard for most text files).

dialectenumRequired
The language variant you'd like us to use for analysis. Choose from American English, British English, or other supported dialects.
Allowed values:
toneenumRequired
The tone variation you're aiming for. Options include formal, academic, casual, and other tone variations to match your content goals.
style_guidestringRequiredformat: "uuid"

The style guide to follow for your content. You can use a style guide ID or choose from built-in options: ap, chicago, or microsoft.

Response

Check run started successfully.
statusenum
Allowed values:
workflow_idstring

Errors