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
family_id
string<uuid>
required

UUID of the family for which the consultation is requested.

capability
string
required

Advisory capability domain being consulted.

context
object

Freeform key-value context passed verbatim to the advisor.

advisor_id
string | null

UUID of a specific advisor to consult. Omit to use the default for this capability.

Response

Consultation result. Verdict may be unavailable if no suitable advisor is registered.

verdict
string

Advisory verdict — one of allow, deny, flag, or unavailable.

consultation_id
string

Audit ID for this consultation. Empty string when no advisor is available (verdict unavailable).

reason
string

Explanation for the verdict. Present on unavailable (e.g. no_advisor).