> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.markup.ai/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.markup.ai/_mcp/server.

# Run Style Agent

POST https://api.markup.ai/style-agent/run
Content-Type: application/json

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, XML (including DITA), Markdown, or plain-text
*file*, use `POST /style-agent/run-file` instead.

Reference: https://docs.markup.ai/developer-reference/api-reference/style-agent/run-style-agent

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Query parameters

- `wait` (boolean, optional, default: false)

### Body (application/json)

This endpoint expects a StyleAgentRunRequest.

- `text` (string, required) — Document text to analyze.
- `style_guide_id` (string, optional, 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_id` (string, optional, nullable) — Language-service content profile ID for style checking.
- `domain_ids` (list of string, optional, nullable) — Terminology domain IDs.
- `document_ref` (string, optional, nullable) — Caller-provided document identifier for tracking across scans.
- `url` (string, optional, nullable) — Document URL.
- `document_name` (string, optional, nullable) — Document name or title.
- `webhook_url` (string, optional, nullable) — Optional webhook URL for async result delivery.

## Response

### 200

Successful Response

- `workflow_id` (string, required) — Workflow ID for tracking
- `status` (enum, required) — Workflow status
  - Allowed values: `running`, `completed`, `failed`, `timed_out`, `cancelled`
- `started_at` (datetime, required) — Workflow start time
- `request_id` (string, optional, nullable) — Request tracking ID
- `document_ref` (string, optional, nullable) — Caller-provided document identifier.
- `check_type` (enum, optional) — How this check is counted: 'batch' for a document checked as part of a batch, 'interactive' for a direct /run check.
  - Allowed values: `interactive`, `automated`, `batch`, `baseline`
- `assigned` (boolean, optional, default: true) — Whether the check counts as authoring activity for an author.
- `batch_id` (string, optional, nullable) — Owning batch id (agbw\_\<nanoid>); null unless this is a batch check.
- `result` (StyleAgentResult, optional, nullable) — Execution result (if completed)
- `completed_at` (datetime, optional, nullable) — Workflow completion time
- `duration_seconds` (double, optional, nullable) — Execution duration

### 201

Completed (wait=true)

- `workflow_id` (string, required) — Workflow ID for tracking
- `status` (enum, required) — Workflow status
  - Allowed values: `running`, `completed`, `failed`, `timed_out`, `cancelled`
- `started_at` (datetime, required) — Workflow start time
- `request_id` (string, optional, nullable) — Request tracking ID
- `document_ref` (string, optional, nullable) — Caller-provided document identifier.
- `check_type` (enum, optional) — How this check is counted: 'batch' for a document checked as part of a batch, 'interactive' for a direct /run check.
  - Allowed values: `interactive`, `automated`, `batch`, `baseline`
- `assigned` (boolean, optional, default: true) — Whether the check counts as authoring activity for an author.
- `batch_id` (string, optional, nullable) — Owning batch id (agbw\_\<nanoid>); null unless this is a batch check.
- `result` (StyleAgentResult, optional, nullable) — Execution result (if completed)
- `completed_at` (datetime, optional, nullable) — Workflow completion time
- `duration_seconds` (double, optional, nullable) — Execution duration

### 202

Accepted (wait=false)

- `workflow_id` (string, required) — Workflow ID for tracking
- `status` (enum, required) — Workflow status
  - Allowed values: `running`, `completed`, `failed`, `timed_out`, `cancelled`
- `started_at` (datetime, required) — Workflow start time
- `request_id` (string, optional, nullable) — Request tracking ID
- `document_ref` (string, optional, nullable) — Caller-provided document identifier.
- `check_type` (enum, optional) — How this check is counted: 'batch' for a document checked as part of a batch, 'interactive' for a direct /run check.
  - Allowed values: `interactive`, `automated`, `batch`, `baseline`
- `assigned` (boolean, optional, default: true) — Whether the check counts as authoring activity for an author.
- `batch_id` (string, optional, nullable) — Owning batch id (agbw\_\<nanoid>); null unless this is a batch check.
- `result` (StyleAgentResult, optional, nullable) — Execution result (if completed)
- `completed_at` (datetime, optional, nullable) — Workflow completion time
- `duration_seconds` (double, optional, nullable) — Execution duration

## Errors

### 401 Unauthorized Error

Authentication failed or no valid API key provided.

- `detail` (string, required) — A description of the error that occurred.
- `status` (integer, required) — The HTTP status code generated by the server for this issue
- `request_id` (string, required) — A unique ID associated with the HTTP request.

### 403 Forbidden Error

Forbidden

- `detail` (string, required) — A description of the error that occurred.
- `status` (integer, required) — The HTTP status code generated by the server for this issue
- `request_id` (string, required) — A unique ID associated with the HTTP request.

### 422 Unprocessable Entity Error

Invalid input for agent

- `any`

### 500 Internal Server Error

Workflow execution failed (wait=true)

- `any`

## Types

### StyleAgentResult

Result of a Style Agent content check. Only the ``analysis`` block is typed here — issues, quality scores, and any agent-specific keys flow through unchanged (``extra="allow"``). Validating ``analysis`` at this edge also mirrors the legacy ``targetId`` naming onto the canonical ``styleGuideId`` keys for results persisted before the rename.

- `analysis` (StyleAgentAnalysis, optional, nullable) — Style guide, content profile, and readability metadata for the checked document. Omitted while the run is in progress and for organizations without numeric scoring.

### StyleAgentAnalysis

Style guide, content profile, and readability metadata forwarded from SLS. Cortex populates this from the language-service ``data.analysis`` block (legacy ``targetId`` naming) and helios_one republishes it on the style-agent API surface. ``styleGuideId`` / ``styleGuideDisplayName`` are the canonical public keys; the legacy ``targetId`` / ``targetDisplayName`` keys carry the same values (and are marked deprecated in the schema) until removed in a future API version. The mirror runs on validation, so results persisted before the rename gain the canonical keys when re-validated.

- `styleGuideId` (string, optional, nullable)
- `styleGuideDisplayName` (string, optional, nullable)
- `contentProfileId` (string, optional, nullable)
- `contentProfileDisplayName` (string, optional, nullable)
- `words` (integer, optional, nullable)
- `sentences` (integer, optional, nullable)
- `clarityIndex` (double, optional, nullable)
- `informalityIndex` (double, optional, nullable)
- `livelinessIndex` (double, optional, nullable)
- `fleschReadingEase` (double, optional, nullable)
- `fleschKincaid` (double, optional, nullable) — Flesch-Kincaid grade level: the approximate US school grade needed to read the text. Lower is easier to read. It has no fixed range.
- `targetId` (string, optional, nullable, deprecated)
- `targetDisplayName` (string, optional, nullable, deprecated)

## Examples

### Example 1

**Request**

```json
{
  "text": "string"
}
```

**Response**

```json
{
  "workflow_id": "string",
  "status": "running",
  "started_at": "2024-01-15T09:30:00Z",
  "request_id": "string",
  "document_ref": "string",
  "check_type": "interactive",
  "assigned": true,
  "batch_id": "string",
  "result": {
    "analysis": {
      "styleGuideId": "string",
      "styleGuideDisplayName": "string",
      "contentProfileId": "string",
      "contentProfileDisplayName": "string",
      "words": 1,
      "sentences": 1,
      "clarityIndex": 1.1,
      "informalityIndex": 1.1,
      "livelinessIndex": 1.1,
      "fleschReadingEase": 1.1,
      "fleschKincaid": 1.1,
      "targetId": "string",
      "targetDisplayName": "string"
    }
  },
  "completed_at": "2024-01-15T09:30:00Z",
  "duration_seconds": 1.1
}
```

**SDK Code**

```python Python
import requests

response = requests.post(
    "https://api.markup.ai/style-agent/run",
    headers={"Authorization": "Bearer YOUR_TOKEN"},
    params={"wait": "true"},
    json={
        "text": "Your content to check.",
        "style_guide_id": "YOUR_STYLE_GUIDE_ID",
        "content_profile_id": "YOUR_CONTENT_PROFILE_ID",
        "document_ref": "handbook/chapter-3",
        "document_name": "Employee Handbook",
        "url": "https://example.com/handbook/chapter-3",
    },
)
print(response.json())

```

```typescript TypeScript
const response = await fetch(
  "https://api.markup.ai/style-agent/run?wait=true",
  {
    method: "POST",
    headers: {
      Authorization: "Bearer YOUR_TOKEN",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      text: "Your content to check.",
      style_guide_id: "YOUR_STYLE_GUIDE_ID",
      content_profile_id: "YOUR_CONTENT_PROFILE_ID",
      document_ref: "handbook/chapter-3",
      document_name: "Employee Handbook",
      url: "https://example.com/handbook/chapter-3",
    }),
  },
);
console.log(await response.json());

```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.markup.ai/style-agent/run"

	payload := strings.NewReader("{\n  \"text\": \"string\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.markup.ai/style-agent/run")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"text\": \"string\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.markup.ai/style-agent/run")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"text\": \"string\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.markup.ai/style-agent/run', [
  'body' => '{
  "text": "string"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.markup.ai/style-agent/run");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"text\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["text": "string"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.markup.ai/style-agent/run")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Example 2

**Request**

```json
{
  "text": "string"
}
```

**Response**

```json
{
  "workflow_id": "string",
  "status": "running",
  "started_at": "2024-01-15T09:30:00Z",
  "request_id": "string",
  "document_ref": "string",
  "check_type": "interactive",
  "assigned": true,
  "batch_id": "string",
  "result": {
    "analysis": {
      "styleGuideId": "string",
      "styleGuideDisplayName": "string",
      "contentProfileId": "string",
      "contentProfileDisplayName": "string",
      "words": 1,
      "sentences": 1,
      "clarityIndex": 1.1,
      "informalityIndex": 1.1,
      "livelinessIndex": 1.1,
      "fleschReadingEase": 1.1,
      "fleschKincaid": 1.1,
      "targetId": "string",
      "targetDisplayName": "string"
    }
  },
  "completed_at": "2024-01-15T09:30:00Z",
  "duration_seconds": 1.1
}
```

**SDK Code**

```python Python
import requests

response = requests.post(
    "https://api.markup.ai/style-agent/run",
    headers={"Authorization": "Bearer YOUR_TOKEN"},
    params={"wait": "true"},
    json={
        "text": "Your content to check.",
        "style_guide_id": "YOUR_STYLE_GUIDE_ID",
        "content_profile_id": "YOUR_CONTENT_PROFILE_ID",
        "document_ref": "handbook/chapter-3",
        "document_name": "Employee Handbook",
        "url": "https://example.com/handbook/chapter-3",
    },
)
print(response.json())

```

```typescript TypeScript
const response = await fetch(
  "https://api.markup.ai/style-agent/run?wait=true",
  {
    method: "POST",
    headers: {
      Authorization: "Bearer YOUR_TOKEN",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      text: "Your content to check.",
      style_guide_id: "YOUR_STYLE_GUIDE_ID",
      content_profile_id: "YOUR_CONTENT_PROFILE_ID",
      document_ref: "handbook/chapter-3",
      document_name: "Employee Handbook",
      url: "https://example.com/handbook/chapter-3",
    }),
  },
);
console.log(await response.json());

```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.markup.ai/style-agent/run"

	payload := strings.NewReader("{\n  \"text\": \"string\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.markup.ai/style-agent/run")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"text\": \"string\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.markup.ai/style-agent/run")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"text\": \"string\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.markup.ai/style-agent/run', [
  'body' => '{
  "text": "string"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.markup.ai/style-agent/run");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"text\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["text": "string"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.markup.ai/style-agent/run")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Example 3

**Request**

```json
{
  "text": "string"
}
```

**Response**

```json
{
  "workflow_id": "string",
  "status": "running",
  "started_at": "2024-01-15T09:30:00Z",
  "request_id": "string",
  "document_ref": "string",
  "check_type": "interactive",
  "assigned": true,
  "batch_id": "string",
  "result": {
    "analysis": {
      "styleGuideId": "string",
      "styleGuideDisplayName": "string",
      "contentProfileId": "string",
      "contentProfileDisplayName": "string",
      "words": 1,
      "sentences": 1,
      "clarityIndex": 1.1,
      "informalityIndex": 1.1,
      "livelinessIndex": 1.1,
      "fleschReadingEase": 1.1,
      "fleschKincaid": 1.1,
      "targetId": "string",
      "targetDisplayName": "string"
    }
  },
  "completed_at": "2024-01-15T09:30:00Z",
  "duration_seconds": 1.1
}
```

**SDK Code**

```python Python
import requests

response = requests.post(
    "https://api.markup.ai/style-agent/run",
    headers={"Authorization": "Bearer YOUR_TOKEN"},
    params={"wait": "true"},
    json={
        "text": "Your content to check.",
        "style_guide_id": "YOUR_STYLE_GUIDE_ID",
        "content_profile_id": "YOUR_CONTENT_PROFILE_ID",
        "document_ref": "handbook/chapter-3",
        "document_name": "Employee Handbook",
        "url": "https://example.com/handbook/chapter-3",
    },
)
print(response.json())

```

```typescript TypeScript
const response = await fetch(
  "https://api.markup.ai/style-agent/run?wait=true",
  {
    method: "POST",
    headers: {
      Authorization: "Bearer YOUR_TOKEN",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      text: "Your content to check.",
      style_guide_id: "YOUR_STYLE_GUIDE_ID",
      content_profile_id: "YOUR_CONTENT_PROFILE_ID",
      document_ref: "handbook/chapter-3",
      document_name: "Employee Handbook",
      url: "https://example.com/handbook/chapter-3",
    }),
  },
);
console.log(await response.json());

```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.markup.ai/style-agent/run"

	payload := strings.NewReader("{\n  \"text\": \"string\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.markup.ai/style-agent/run")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"text\": \"string\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.markup.ai/style-agent/run")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"text\": \"string\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.markup.ai/style-agent/run', [
  'body' => '{
  "text": "string"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.markup.ai/style-agent/run");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"text\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["text": "string"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.markup.ai/style-agent/run")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```