List Guard Rails
Guard Rails
List Guard Rails
Retrieve a list of all guard rails in your organization.
GET
List Guard Rails
Headers
Your API key for authentication.
Query Parameters
Filter guard rails by the type of source they’re attached to.Options:
PERSONA, PATHWAY, INBOUNDFilter guard rails by a specific source ID (must be a valid UUID).
Response
Array of guard rail objects.
Unique identifier for the guard rail.
Organization ID that owns this guard rail.
Type of guard rail. One of:
tcpa:ai_disclosure, tcpa:recording_disclosure, tcpa:self_introduction, tcpa:opt_out, or custom.Name of the guard rail (for custom guard rails).
Description of the guard rail (for custom guard rails).
Detection prompt (only for custom guard rails).
Configuration object. For TCPA time-based guard rails, contains
end_seconds.Array of sources this guard rail is attached to. Each attachment contains
source_type (PERSONA, PATHWAY, or INBOUND), source_id, and actions.ISO 8601 timestamp of when the guard rail was created.
ISO 8601 timestamp of when the guard rail was last modified.
Any errors that occurred (null if none).
Docs for agents: llms.txt