Create Guardrail Version

Create a new guardrail version.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Creates a new version of a guardrail with a name, an optional description, and its guardrules, such as allowed topics, toxicity, PII detection, jailbreak detection, or image checks. Publishing a guardrail creates a new version, which keeps previous versions traceable.

When to use it

Use it to publish a change to a guardrail's rules. Agents connected to the guardrail keep using the previous version until you explicitly update them to the latest one.

Required parameters

  • guardrail_id (path): the ID of the guardrail.
  • name (body): the name of the version.

Optional body fields: description, guardrules.

Response

A successful call returns 201 Created with the GuardrailVersionSchema object: id, guardrail_id, name, description, guardrules, and timestamps.

Related: List guardrail versions, Run guardrail versions, Update a guardrail version, Create a guardrail

Path Params
uuid
required
Body Params
string
required
length between 1 and 95
length ≤ 100
guardrules
array
Defaults to []
Guardrules
Responses

401

Unauthorized

404

Not Found

422

Unprocessable Entity

500

Internal Server Error

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json