Skip to main content
GET
/
v1
/
guard_rails
List Guard Rails
curl --request GET \
  --url https://api.bland.ai/v1/guard_rails \
  --header 'authorization: <authorization>'
{
  "data": [
    {
      "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "org_id": "12345678-1234-1234-1234-123456789012",
      "type": "tcpa:ai_disclosure",
      "name": null,
      "description": null,
      "prompt": null,
      "config": {
        "end_seconds": 30
      },
      "attachments": [
        {
          "source_type": "PERSONA",
          "source_id": "98765432-1234-1234-1234-123456789012",
          "actions": [
            { "type": "end_call" }
          ]
        }
      ],
      "created_at": "2025-01-15T10:30:00.000Z",
      "updated_at": "2025-01-15T10:30:00.000Z"
    },
    {
      "id": "b2c3d4e5-6789-01bc-defg-2345678901bc",
      "org_id": "12345678-1234-1234-1234-123456789012",
      "type": "custom",
      "name": "No Medical Advice",
      "description": "Prevents the agent from providing medical advice",
      "prompt": "Flag if the agent provides any medical advice, diagnosis, or treatment recommendations",
      "config": {},
      "attachments": [
        {
          "source_type": "PATHWAY",
          "source_id": "11111111-2222-3333-4444-555555555555",
          "actions": [
            { "type": "transfer", "config": { "phone_number": "+15551234567" } }
          ]
        }
      ],
      "created_at": "2025-01-16T14:20:00.000Z",
      "updated_at": "2025-01-16T14:20:00.000Z"
    }
  ],
  "errors": null
}

​
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).
{
  "data": [
    {
      "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "org_id": "12345678-1234-1234-1234-123456789012",
      "type": "tcpa:ai_disclosure",
      "name": null,
      "description": null,
      "prompt": null,
      "config": {
        "end_seconds": 30
      },
      "attachments": [
        {
          "source_type": "PERSONA",
          "source_id": "98765432-1234-1234-1234-123456789012",
          "actions": [
            { "type": "end_call" }
          ]
        }
      ],
      "created_at": "2025-01-15T10:30:00.000Z",
      "updated_at": "2025-01-15T10:30:00.000Z"
    },
    {
      "id": "b2c3d4e5-6789-01bc-defg-2345678901bc",
      "org_id": "12345678-1234-1234-1234-123456789012",
      "type": "custom",
      "name": "No Medical Advice",
      "description": "Prevents the agent from providing medical advice",
      "prompt": "Flag if the agent provides any medical advice, diagnosis, or treatment recommendations",
      "config": {},
      "attachments": [
        {
          "source_type": "PATHWAY",
          "source_id": "11111111-2222-3333-4444-555555555555",
          "actions": [
            { "type": "transfer", "config": { "phone_number": "+15551234567" } }
          ]
        }
      ],
      "created_at": "2025-01-16T14:20:00.000Z",
      "updated_at": "2025-01-16T14:20:00.000Z"
    }
  ],
  "errors": null
}