Skip to main content
GET
Get a capability document

Headers

x-anyreach-org
string | null

Organization ID for user PATs (pat_ prefix tokens)

Path Parameters

agent_id
string
required

Response

CapabilityDocument · object | null

Successful Response

One agent's capability document.

content is null until a generation has succeeded, and a later failure leaves the last good content in place — so a row with status == "failed" and content present is a published document whose refresh failed, not a broken one.

id
string
required
organization_id
string
required
agent_id
string
required
status
enum<string>
required
Available options:
pending,
running,
ready,
quality_failed,
failed,
ineligible
source_config_version
integer | null
workflow_id
string | null
content
Content · object | null
is_public
boolean
default:true
check_failures
Check Failures · object[]
residue
string[]
generated_by
string | null
error
string | null
created_at
string<date-time> | null
updated_at
string<date-time> | null
stale
boolean
default:false