Guardrailz
HomeHubBlogsPricingDocs

Introduction

  • Overview
  • Architecture
  • Core Concepts

Getting Started

  • Installation
  • Quickstart
  • Playground

API

  • Validate API
  • Profiles API
  • Analytics API
  • Error Handling

SDK

  • Overview
  • Client
  • Guardrails
  • Examples

Guardrails

  • Overview
  • Input Guardrails
  • Output Guardrails
  • Tool Guardrails
  • Custom Guardrails

Profiles

  • Overview
  • Built-in Profiles
  • Custom Profiles
  • Profile Compilation

Analytics

  • Overview
  • Events
  • Queries
  • Dashboards

Deployment

  • Environment
  • Security
  • Scaling
  1. Docs
  2. /api
  3. /profiles

Profiles API

Profiles define guardrail policies that control how validation is performed.

They allow guardrails to be reused, versioned, and managed independently of code.

List Profiles

 
GET /api/profiles
 

Returns all profiles available to the authenticated user.

Response

{
  "profiles": [
    {
      "id": "default",
      "name": "Default",
      "description": "Baseline production guardrails",
      "isBuiltIn": true
    }
  ]
}

Create Profile

POST /api/profiles

Request

{
  "name": "strict-security",
  "description": "High security profile",
  "inputGuardrails": [{ "name": "SecretsInInput", "config": { "severity": "critical" } }],
  "outputGuardrails": [],
  "toolGuardrails": []
}

Built-in Profiles

Guardrails ships with curated profiles such as:

  • default
  • enterprise_security
  • child_safety
  • healthcare
  • financial
  • minimal

These are automatically initialized per user.

Best Practices

  • Use built-in profiles as a starting point
  • Clone and customize for application-specific needs
  • Avoid frequent profile changes in production