Introduction
Conversation
Objectives
Guardrails
Knowledge Base
curl --request GET \
--url https://tavusapi.com/v2/guardrails/{guardrails_id} \
--header 'x-api-key: <api-key>'{
"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",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}
}Get Guardrails (One Set)
This endpoint returns a single set of guardrails by its unique identifier.
curl --request GET \
--url https://tavusapi.com/v2/guardrails/{guardrails_id} \
--header 'x-api-key: <api-key>'{
"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",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}
}Authorizations
Path Parameters
The unique identifier of the guardrails.
"g12345"
Response
Successfully retrieved guardrails
Show child attributes
Show child attributes
Name of the individual guardrail. Only alphanumeric characters and underscores are allowed.
"healthcare_compliance_guardrail"
The detailed prompt that defines the behavioral boundaries and restrictions
"Never discuss competitor products, share sensitive medical information, or provide medical advice outside approved guidelines"
The communication modality for an individual guardrail. If set to verbal, the guardrail will be enforced by the user's responses. If set visual, the guardrail can only be enforced by visual / perception cues observed by Raven
verbal, visual "verbal"
URL that will receive notifications when the guardrail is triggered
"https://your-server.com/guardrails-webhook"
ISO 8601 timestamp of when the guardrails were created
"2024-01-15T10:30:00Z"
ISO 8601 timestamp of when the guardrails were last updated
"2024-01-15T10:30:00Z"