Get Guardrails in Organization

GET

/api/v2/organizations/{organization_id}/guardrails

Guardrailsv2

Retrieve a paginated list of all guardrails in the specified organization. This endpoint allows you to view all guardrails associated with the organization, including their details and configurations.

Path Parameters:

organization_id (int): ID of the organization to retrieve guardrails for

Query Parameters:

page (int, optional): Page number for pagination (default: 1)
items_per_page (int, optional): Number of items per page for pagination (default: 50)

Returns:

Response: JSON response containing paginated list of guardrails in the organization

Response Example

200 - Successful Response

{
    "success": true,
    "message": "string",
    "data": {
        "count": 3,
        "num_pages": 1,
        "current_page": 1,
        "guardrails": [
            {
                "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"
                ]
            },
            {
                "id": 2,
                "name": "Ethics Filter",
                "description": "Ensures responses are ethically sound",
                "created_on": "2024-03-14T14:20:00Z",
                "modified_on": "2024-03-15T11:45:00Z",
                "created_by": "admin@example.com",
                "modified_by": "admin@example.com",
                "organization_id": 1,
                "guardrail_type": "ethical_moderation",
                "is_enabled": true,
                "is_default": true,
                "is_deleted": false
            },
            {
                "id": 3,
                "name": "Prompt Injection Detector",
                "description": "Prevents prompt injection attacks",
                "created_on": "2024-03-13T09:30:00Z",
                "modified_on": "2024-03-13T09:30:00Z",
                "created_by": "admin@example.com",
                "modified_by": "admin@example.com",
                "organization_id": 1,
                "guardrail_type": "jailbreak_detection",
                "is_enabled": true,
                "is_default": false,
                "is_deleted": false
            }
        ]
    }
}

Request

Path Params

organization_id

integer

required

Query Params

embed

string

optional

Comma-separated list of related entities to embed in the response

Example:

organization

fields

string

optional

Comma-separated list of specific fields to include in the response

Example:

id,name,description,guardrail_type

guardrail_type

enum<string>

optional

Filter by guardrail type

Allowed values:

ethical_moderationhallucinationjailbreak_detectionmask_sensitive_datatopic_control

Example:

topic_control

is_enabled

boolean

optional

Filter by enabled status

Example:

true

items_per_page

integer

optional

Number of items per page

Default:

Example:

page

integer

optional

Page number

Default:

Example:

verbosity

enum<string>

optional

Level of detail in response

Allowed values:

highlowmedium

Default:

medium

Example:

low

Responses

🟢200OK

application/json

Body

data

object (OrganizationGuardrailDetailView_GET_GuardrailSerializer_Paginated_Data)

required

count

integer | null

optional

Total number of items

num_pages

integer | null

optional

Total number of pages

current_page

integer | null

optional

Current page number

guardrails

array[object (Guardrail) {7}]

optional

success

boolean

required

message

string

required

🟠400Bad Request

🔴500Server Error

Delete Guardrails

Create Guardrail in Organization