Sign in
styleAgent

Get Style Agent Workflow

Get the status and result of a Style Agent content-check run.

Poll with the workflow id returned by POST /style-agent/run. While the run is in progress the status reflects its state; once it completes the response includes the result.

get/style-agent/workflows/{workflow_id}

Path parameters

workflow_idstring required

Headers

Authorizationstring required

Bearer authentication

Response

Successful Response

workflow_idstring required

Workflow ID

agent_idstring

Agent that ran this workflow

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.

status'running' | 'completed' | 'failed' | 'timed_out' | 'cancelled' required

Status of a workflow execution.

started_atstring date-time required

Start time

completed_atstring date-time nullable

Workflow completion time

Changes