Get Style Agent Workflow

GET

https://api.markup.ai/style-agent/workflows/:workflow_id

GET

/style-agent/workflows/:workflow_id

curl https://api.markup.ai/style-agent/workflows/workflow_id \
     -H "Authorization: Bearer <token>"

{
  "workflow_id": "string",
  "status": "running",
  "started_at": "2024-01-15T09:30:00Z",
  "agent_id": "",
  "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,
      "targetId": "string",
      "targetDisplayName": "string"
    }
  },
  "completed_at": "2024-01-15T09:30:00Z"
}

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.

Authentication

AuthorizationBearer

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

Path parameters

workflow_idstringRequired

Response

Successful Response

workflow_idstring

Workflow ID

statusenum

Current status

started_atdatetime

Start time

agent_idstringOptionalDefaults to

Agent that ran this workflow

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.

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

Result (if completed)

completed_atdatetime or nullOptional

Workflow completion time

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error