Get available guardrail types for agent
GET
/api/v2/agents/{agent_id}/guardrails
agent_id (int): ID of the agent
verbosity (str, optional): Control level of detail ('low', 'medium', 'high')
fields (str, optional): Comma-separated list of specific fields to include
embed (str, optional): Comma-separated list of related entities to embed
paginated (str, optional): Whether to paginate results (true/false)
page (int, optional): Page number for paginated results
items_per_page (int, optional): Number of items per page for paginated results
JSON response with guardrail types and their status
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https:///api/v2/agents//guardrails' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer 'Response Response Example
200 - Successful Response
{
"success": true,
"message": "Guardrail types retrieved successfully",
"data": {
"guardrail_types": [
{
"type": "topic_control",
"name": "Topic Control",
"description": "Controls what topics the agent can discuss",
"enabled": true,
"guardrail": {
"id": 1,
"name": "Content Boundaries",
"description": "Restricts discussions to safe topics",
"created_on": "2024-03-15T10:30:00Z",
"modified_on": "2024-03-16T09:15:00Z",
"created_by": "admin@example.com",
"modified_by": "admin@example.com",
"organization_id": 1,
"guardrail_type": "topic_control",
"is_enabled": true,
"is_default": false,
"is_deleted": false,
"guidelines": [
"No discussions about illegal activities",
"No harmful content"
]
}
},
{
"type": "ethical_moderation",
"name": "Ethical Moderation",
"description": "Ensures responses are ethically sound",
"enabled": false
}
]
}
}Request
Path Params
Query Params
Header Params