latestOpenAPI 3.1.02026-08-226994571.1 MB

1e929292ddd5

Guardrails

Get Provider Specific Params

Get provider-specific parameters for different guardrail types.

Returns a dictionary mapping guardrail providers to their specific parameters, including parameter names, descriptions, and whether they are required.

Example Response:

{
    "bedrock": {
        "guardrailIdentifier": {
            "description": "The ID of your guardrail on Bedrock",
            "required": true,
            "type": null
        },
        "guardrailVersion": {
            "description": "The version of your Bedrock guardrail (e.g., DRAFT or version number)",
            "required": true,
            "type": null
        }
    },
    "azure_content_safety_text_moderation": {
        "api_key": {
            "description": "API key for the Azure Content Safety Text Moderation guardrail",
            "required": false,
            "type": null
        },
        "optional_params": {
            "description": "Optional parameters for the Azure Content Safety Text Moderation guardrail",
            "required": true,
            "type": "nested",
            "fields": {
                "severity_threshold": {
                    "description": "Severity threshold for the Azure Content Safety Text Moderation guardrail across all categories",
                    "required": false,
                    "type": null
                },
                "categories": {
                    "description": "Categories to scan for the Azure Content Safety Text Moderation guardrail",
                    "required": false,
                    "type": "multiselect",
                    "options": ["Hate", "SelfHarm", "Sexual", "Violence"],
                    "default_value": None
                }
            }
        }
    }
}
get/guardrails/ui/provider_specific_params

Response

Successful Response

{"stackTrail":"paths:/guardrails/ui/provider_specific_params:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}