Skip to main content
POST
/
v2
/
guardrails
Create Guardrails
curl --request POST \
  --url https://tavusapi.com/v2/guardrails \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "data": [
    {
      "guardrail_name": "healthcare_compliance_guardrail",
      "guardrail_prompt": "Never discuss competitor products, share sensitive medical information, or provide medical advice outside approved guidelines",
      "modality": "verbal",
      "callback_url": "https://your-server.com/guardrails-webhook"
    }
  ]
}
'
{
  "guardrails_id": "g12345",
  "guardrails_name": "Healthcare Compliance Guardrails",
  "status": "active",
  "created_at": "2024-01-15T10:30:00Z"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
name
string

A descriptive name for the collection of individual guardrails

​
data
object[]

A list of individual guardrails

Response

Guardrails created successfully

​
guardrails_id
string

Unique identifier for the created guardrails

Example:

"g12345"

​
guardrails_name
string

Name of the guardrails

Example:

"Healthcare Compliance Guardrails"

​
status
string

Current status of the guardrails

Example:

"active"

​
created_at
string

ISO 8601 timestamp of when the guardrails were created

Example:

"2024-01-15T10:30:00Z"