Guard Rails
Update Guard Rail
Update an existing guard rail configuration.
PATCH
The
type field cannot be changed after creation. To change the type, delete the guard rail and create a new one.Headers
string
required
Your API key for authentication.
Path Parameters
string
required
The unique identifier of the guard rail to update.
Body Parameters
All fields are optional. Only include fields you want to update.string
Updated name for the guard rail (custom guard rails only).
string
Updated description (custom guard rails only).
string
Updated detection prompt (custom guard rails only).
object
Updated configuration object. For TCPA time-based guard rails, set
end_seconds to change the time window.array
Updated array of sources to attach this guard rail to. This replaces all existing attachments.Each attachment requires:
source_type(string) - Type of source:PERSONA,PATHWAY, orINBOUNDsource_id(string) - ID of the source to attach toactions(array) - Actions to take when the guard rail triggers
Response
object
The updated guard rail object containing
id, org_id, type, name, description, prompt, config, attachments, created_at, and updated_at.array
Any errors that occurred (null if none).
Docs for agents: llms.txt