v1

latestOpenAPI 3.1.02026-08-06387578.8 KB

agents

Run Agent

Run an agent.

Use wait=true to block until the workflow completes (201 Created). Default (wait=false) returns immediately with 202 Accepted.

post/agents/{agent_id}/run

Path parameters

agent_idstring required

Query parameters

waitboolean

Headers

Authorizationstring required

Bearer authentication

Request body

textstring required

Document text to analyze.

agentsstring[] nullable

Agent IDs to execute. Resolved to agent names server-side.

domain_idsstring[] nullable

Terminology domain IDs.

document_refstring nullable

Caller-provided document identifier for tracking across scans.

urlstring nullable

Document URL.

document_namestring nullable

Document name or title.

style_guide_idstring 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_idstring nullable

Language-service content profile ID for style checking.

goalstring nullable

Document goal for agent recommendation.

persona_idstring nullable

Agent configuration UUID for persona selection. Used by: persona.

voice_profile_idstring nullable

Agent configuration UUID for brand voice profile selection. Used by: brand_voice.

webhook_urlstring uri nullable

Optional webhook URL for async result delivery.

Response

Successful Response

workflow_idstring required

Workflow ID for tracking

request_idstring nullable

Request tracking ID

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

Status of a workflow execution.

document_refstring nullable

Caller-provided document identifier.

resultobject nullable

Execution result (if completed)

started_atstring date-time required

Workflow start time

completed_atstring date-time nullable

Workflow completion time

duration_secondsnumber double nullable

Execution duration