v1

latestOpenAPI 3.0.32026-07-267015229.9 KB
Guardrails

List Guardrails

Return a flat list of guardrails owned by the caller. Pass legacy=false - recommended for all new integrations. The legacy=true behavior returns the deprecated guardrail set list.

get/v2/guardrails

Query parameters

legacy'true' | 'false'

Pass false to return individual guardrails (recommended). Defaults to true for backwards compatibility, which returns the deprecated guardrail set list.

limitinteger

Number of guardrails to return per page. Default is 10.

pageinteger

Page number (0-indexed when legacy=false). Default is 0.

sort'ascending' | 'descending'

Sort direction. Default is ascending.

name_or_uuidstring

Filter results by guardrail name or UUID.

tagsstring

Comma-separated list of tags to filter by. Any-match (OR) semantics.

Response

Successfully retrieved guardrails

total_countinteger

Total number of guardrails matching the filter.

pageinteger
limitinteger

Example response

{
  "data": [
    {
      "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"
    }
  ],
  "total_count": 15,
  "limit": 10
}