actor-preferences

Get the tool-approval policy

Read an actor's tool-approval policy (your own, or anyone's if you are an admin).

get/v1/actor-preferences/approval-policy

Request

  • Base URL: https://api.patricia.app (the document declares no server; this is the origin it was published from)
  • URL: https://api.patricia.app/v1/actor-preferences/approval-policy
  • Auth: HTTP bearer

Query parameters

actor_idstring uuid nullable

Headers

X-Tenant-Idstring nullable

Response

Successful Response

actor_idstring uuid required
mode'default' | 'always' | 'never' | 'tiers' required

How a user's per-actor approval preference shapes the tool-approval gate.

Pure runtime concept, NOT a code-table. It never appears as a *_code column; it is the mode field inside the JSON value of the approval_policy :class:~models.preference.ActorPreference, so it is validated by Pydantic (models.approval_policy) rather than seeded into a reference table. Explicit Read, Write and Critical choices outrank mode. An unset Critical choice keeps its tier card. Always allow can skip the confirm card for Critical actions from built-in tools and from Composio actions with a valid output contract. Actions from MCP connections and other apps still ask first. Under this setting alone, actions whose names look credential-shaped, actions that request credential reveal, and actions with missing or unreadable evidence keep their cards. Target-bound approval rules remain. Requester-bound cards remain unless you chose Always allow on that action's approval card.

tiersRiskTier[] required
floor_tiersRiskTier[] required

The default tier approval floor. An explicit Critical Always allow choice can waive it.

read_tier'always_allow' | 'always_ask' required

A member's explicit Allow/Ask choice for Read, Write or Critical actions.

Critical defaults to Ask. Always allow can skip the confirm card for Critical actions from built-in tools and from Composio actions with a valid output contract. Actions from MCP connections and other apps still ask first. Under this setting alone, actions whose names look credential-shaped, actions that request credential reveal, and actions with missing or unreadable evidence keep their cards. A member may change only their own Critical choice.

write_tier'always_allow' | 'always_ask' required

A member's explicit Allow/Ask choice for Read, Write or Critical actions.

Critical defaults to Ask. Always allow can skip the confirm card for Critical actions from built-in tools and from Composio actions with a valid output contract. Actions from MCP connections and other apps still ask first. Under this setting alone, actions whose names look credential-shaped, actions that request credential reveal, and actions with missing or unreadable evidence keep their cards. A member may change only their own Critical choice.

critical_tier'always_allow' | 'always_ask' required

A member's explicit Allow/Ask choice for Read, Write or Critical actions.

Critical defaults to Ask. Always allow can skip the confirm card for Critical actions from built-in tools and from Composio actions with a valid output contract. Actions from MCP connections and other apps still ask first. Under this setting alone, actions whose names look credential-shaped, actions that request credential reveal, and actions with missing or unreadable evidence keep their cards. A member may change only their own Critical choice.

explicit_tier_groupsstring[] required

Which of read/write/critical above are YOUR OWN choice rather than a value synthesized from mode/tiers. Trust read_tier/write_tier/critical_tier as the actor's real, unambiguous decision only for a group listed here — for one that is not, mode/tiers can still disagree with part of the group even though this field reports one value for it. Transitional for PAT-1755's mode/tiers retirement: expect every actor to list all three groups, and this field to become a no-op, once that series removes mode/tiers.

Changes

No recorded changes to this operation across all 1 revision of this API.