Skip to main content
GET
List Guard Rails

Headers

authorization
string
required
Your API key for authentication.

Query Parameters

source_type
string
Filter guard rails by the type of source they’re attached to.Options: PERSONA, PATHWAY, INBOUND
source_id
string
Filter guard rails by a specific source ID (must be a valid UUID).

Response

data
array
Array of guard rail objects.
data[].id
string
Unique identifier for the guard rail.
data[].org_id
string
Organization ID that owns this guard rail.
data[].type
string
Type of guard rail. One of: tcpa:ai_disclosure, tcpa:recording_disclosure, tcpa:self_introduction, tcpa:opt_out, or custom.
data[].name
string
Name of the guard rail (for custom guard rails).
data[].description
string
Description of the guard rail (for custom guard rails).
data[].prompt
string
Detection prompt (only for custom guard rails).
data[].config
object
Configuration object. For TCPA time-based guard rails, contains end_seconds.
data[].attachments
array
Array of sources this guard rail is attached to. Each attachment contains source_type (PERSONA, PATHWAY, or INBOUND), source_id, and actions.
data[].created_at
string
ISO 8601 timestamp of when the guard rail was created.
data[].updated_at
string
ISO 8601 timestamp of when the guard rail was last modified.
errors
array
Any errors that occurred (null if none).

Docs for agents: llms.txt