Skip to content
Extrovert Extrovert Docs

Read the effective risk dial (console plane)

GET
/v1/admin/orgs/{org_id}/projects/{project_id}/risk-dial

Read the effective brand-risk dial; the account-wide default plus every category’s per-category overrides (each with its resolved effective value; null override = inherit, D12). The agent-plane read (GET /v1/risk-dial) is AgentKey-only, so the console reads the SAME view here (Clerk session) to render the risk-dial panel. Read-only; setting the dial is the PATCH above.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
org_id
required
string
project_id
required
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Ok

The effective risk dial (Review Loop, agent plane; D4/D12): the account default plus every category’s overrides (each with its resolved effective value). Read-only for agents; flipping the dial is a console (human) action (D16).

object
account
required

The account-wide default risk dial (org_settings; D4/D12); the values a per-category null override inherits. The single user-configurable brand-risk lever (canary rate, drift-demote K, maturity-gate thresholds, min confidence, first-contact gate, per-day auto-send cap).

object
min_confidence
required
number format: double
first_contact_gate
required
boolean
drift_demote_after
required

Drift-demote threshold K.

integer
canary_rate
required
number format: double
graduate_min_approvals
required

Maturity-gate N (clean approvals).

integer
graduate_min_age_hours
required

Maturity-gate minimum category age.

integer
auto_send_cap_per_day
required

Plan-tier per-customer auto-send volume cap (D1).

integer
categories
required
Array<object>

One category’s risk-dial OVERRIDE columns (null = inherit the account default; D12) alongside the resolved effective dial. A null field means the category inherits that value from the account default.

object
category_id
required
string
min_confidence
number format: double
nullable
first_contact_gate
boolean
nullable
drift_demote_after
integer
nullable
canary_rate
number format: double
nullable
graduate_min_approvals
integer
nullable
graduate_min_age_hours
integer
nullable
effective
required

The RESOLVED risk dial for a category: the account default with any per- category override applied (null override = inherit; D12). Every field is a concrete value already in force.

object
min_confidence
required
number format: double
first_contact_gate
required
boolean
drift_demote_after
required
integer
canary_rate
required
number format: double
graduate_min_approvals
required
integer
graduate_min_age_hours
required
integer
auto_send_cap_per_day
required
integer

401

Section titled “401 ”

Missing or invalid credential.

The canonical error envelope. error is a stable machine code.

object
error
required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string
Example
forbidden
message

Human-readable detail (never leaks internals).

string
Example
missing required scope
reason

Machine-readable quota reason. inbox_limit_exceeded means billing account inbox capacity across all organizations and projects sharing that account; enrollment_token_mailbox_budget_exhausted means the enrollment key lifetime creation allowance. Read message for recovery; inbox counts are separate from sending quotas.

string
used

Consumed plus reserved units.

integer format: int64
delta

Requested additional units.

integer format: int64
limit
integer format: int64
remaining
integer format: int64
consumed
integer format: int64
reserved
integer format: int64
next_reset_at

Next UTC usage-period boundary; pending reservations survive this boundary.

string format: date-time
upgrade_required
boolean

403

Section titled “403 ”

Authenticated but lacking the required scope, or out of quota.

The canonical error envelope. error is a stable machine code.

object
error
required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string
Example
forbidden
message

Human-readable detail (never leaks internals).

string
Example
missing required scope
reason

Machine-readable quota reason. inbox_limit_exceeded means billing account inbox capacity across all organizations and projects sharing that account; enrollment_token_mailbox_budget_exhausted means the enrollment key lifetime creation allowance. Read message for recovery; inbox counts are separate from sending quotas.

string
used

Consumed plus reserved units.

integer format: int64
delta

Requested additional units.

integer format: int64
limit
integer format: int64
remaining
integer format: int64
consumed
integer format: int64
reserved
integer format: int64
next_reset_at

Next UTC usage-period boundary; pending reservations survive this boundary.

string format: date-time
upgrade_required
boolean