Patch Guardrails

curl --request PATCH \ --url https://tavusapi.com/v2/guardrails/{guardrail_id} \ --header 'Content-Type: application/json' \ --header 'x-api-key: <api-key>' \ --data ' [ { "op": "replace", "path": "/guardrail_prompt", "value": "Never discuss competitor products under any circumstances." } ] '

{ "uuid": "g1234567890ab", "guardrail_name": "<string>", "guardrail_prompt": "<string>", "modality": "<string>", "callback_url": "<string>", "tags": [ "<string>" ], "app_message": true, "updated_at": "<string>" }

Authorizations

x-api-key

string

header

required

Path Parameters

guardrail_id

string

required

The unique identifier of the guardrail.

Example:

"g1234567890ab"

Body

application/json

enum<string>

required

Available options:

add,

remove,

replace,

copy,

move,

test

Example:

"replace"

path

string

required

JSON Pointer (RFC 6901) to a field on the guardrail (e.g. /guardrail_prompt, /tags, /modality).

Example:

"/guardrail_prompt"

value

any

The value used by the operation. Not required for remove.

Example:

"Updated prompt with stricter restrictions."

Response

Guardrail updated successfully

uuid

string

Example:

"g1234567890ab"

guardrail_name

string

guardrail_prompt

string

modality

string

callback_url

string

Introduction

Conversation

PAL

Face

Tools

Skills

Magic Canvas

Objectives

Guardrails

Knowledge Base

Pronunciation Dictionaries

Voices

Deployments

Patch Guardrails

Authorizations

Path Parameters

Body

Response