v1

latestOpenAPI 3.0.32026-07-267015229.9 KB

Guardrails

Get Guardrails

Retrieve a single guardrail by its unique identifier.

get/v2/guardrails/{guardrail_id}

Response

Successfully retrieved the guardrail

uuidstring

guardrail_namestring

guardrail_promptstring

modality'verbal' | 'visual'

callback_urlstring

tagsstring[]

app_messageboolean

Whether triggering this guardrail emits a real-time app-message event on the conversation.

created_atstring

updated_atstring

Example response

{
  "uuid": "g1234567890ab",
  "guardrail_name": "healthcare_compliance_guardrail",
  "guardrail_prompt": "Never share sensitive medical information or provide medical advice outside approved guidelines.",
  "modality": "verbal",
  "callback_url": "https://your-server.com/guardrails-webhook",
  "tags": [
    "compliance",
    "healthcare"
  ],
  "app_message": true,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}