Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

A logged-in user session bearer token (WorkOS AuthKit access token from signup/login).

Body

application/json
slug
string
required

Unique identifier slug for the advisor agent.

display_name
string
required

Human-readable name for the advisor.

public_key_pem
string
required

Ed25519 public key in PEM format, used to verify advisory signatures.

key_id
string
required

Identifier for the signing key (forms the did#kid).

scope
enum<string>
required

family = per-family advisory (scope_family_id required); global = coalition-wide advisory (manifest_url required).

Available options:
family,
global
publisher_org
string

Name of the organization publishing this advisor.

callback_url
string

HTTPS callback endpoint for advisory verdicts.

capability_domains
string[]

Advisory capability domains this agent supports. An unrecognized capability name causes the request to be rejected with a 400 error (unknown_capability: <name>). A recognized capability that is above the provisional band is silently dropped (skipped) from the accepted set.

scope_family_id
string<uuid> | null

Family UUID to scope this advisor to. Required when scope=family.

manifest_url
string | null

URL of the advisor manifest. Required when scope=global.

Response

Advisor registered at provisional tier.

advisor_id
string<uuid>
slug
string
trust_tier
string

Always provisional on initial registration.

verification_token
string

DNS verification token. Present only when scope=global.

verification_instructions
string

Human-readable DNS TXT record instructions. Present only when scope=global.