Skip to navigation

Get guardrail rule

Authentication

AuthorizationBearer

Authenticate server-side requests with a private Vapi API key. Create or copy a key from the Vapi Dashboard and send it in the Authorization header as Bearer <token>. Keep private API keys out of client-side code and public repositories.

Path parameters

idstringRequiredformat: "uuid"
The unique identifier for the resource.

Response

idstringformat: "uuid"
orgIdstringformat: "uuid"
createdAtdatetime
updatedAtdatetime
namestringformat: "/\S/"
sensitivityenum

Evaluation sensitivity; numeric cutoffs are internal and provisional.

Allowed values:
actionobject
Supplied PATCH actions replace the complete variant.
authoringobject or nullOptional

Structured editor input. Supplied PATCH authoring replaces the complete object; advanced text writes clear it to null.

instructionsstringOptionalformat: "/\S/"
Evaluated instructions, generated from authoring or supplied in advanced mode.