Skip to main content
GET
/
guardrails
Get Guardrails
curl --request GET \
  --url https://proxy.qualifire.ai/api/guardrails \
  --header 'X-Qualifire-API-Key: <api-key>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "created_at": "<string>",
    "active": true,
    "trigger": "<string>",
    "error_threshold": 50,
    "warning_threshold": 50,
    "evaluations": {
      "request_evaluation": "<string>",
      "response_evaluation": "<string>"
    },
    "actions": {
      "block": true,
      "default_response": "<string>",
      "retry": true,
      "retry_cap": 5,
      "alert": {
        "email": "<string>",
        "message": "<string>",
        "cooldown": 0
      }
    }
  }
]

Authorizations

X-Qualifire-API-Key
string
header
required

Query Parameters

limit
integer

The maximum number of Guardrails to return

offset
integer

The offset of the Guardrails to return

Response

OK

id
string

The ID of the Guardrail

name
string

The name of the Guardrail

description
string

The description of the Guardrail

created_at
string

The creation date of the Guardrail

active
boolean
default:true

Whether the Guardrail is active

trigger
string

The trigger of the Guardrail

error_threshold
integer

The error threshold of the Guardrail

Required range: 0 <= x <= 100
warning_threshold
integer

The warning threshold of the Guardrail

Required range: 0 <= x <= 100
evaluations
object
actions
object
I