Guardrails

Get a guardrail

Returns a single guardrail by ID.

get/v1/projects/{project_id}/guardrails/{guardrail_id}

Request

  • Base URL: https://api.naturali.ai
  • URL: https://api.naturali.ai/v1/projects/{project_id}/guardrails/{guardrail_id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.naturali.ai/authorize, token URL https://api.naturali.ai/token, scopes: mcp:access)

Path parameters

guardrail_idstring required

Response

Guardrail

idstring

Public ID of the guardrail

project_idstring

Public ID of the owning project

namestring

Human-readable name

descriptionstring nullable

Optional description

versioninteger

Incremented on every document write; prior versions are archived

context_tool_idstring nullable

Optional tool the platform calls at evaluation time to fetch fresh guardrail context.

context_mode'merge' | 'replace' | 'null' nullable

How tool-fetched context combines with the caller-supplied context.

created_atstring date-time
updated_atstring date-time

Example response

{
  "id": "guard_V1StGXR8Z5jdHi6B",
  "project_id": "proj_V1StGXR8Z5jdHi6B",
  "name": "Budget Update Guardrail",
  "version": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.