Skip to navigation

List guardrail rules

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.

Query parameters

limitdoubleOptional1-1000Defaults to 100
Positive bounded list size, matching the shared library reader.
searchstringOptional

Case-insensitive name or identifier fragment; omitted means all resources.

packIdstringOptionalformat: "uuid"

Limits rules to a pack in the authenticated organization without per-member requests.

createdAtGtdatetimeOptional
This will return items where the createdAt is greater than the specified value.
createdAtLtdatetimeOptional
This will return items where the createdAt is less than the specified value.
createdAtGedatetimeOptional
This will return items where the createdAt is greater than or equal to the specified value.
createdAtLedatetimeOptional
This will return items where the createdAt is less than or equal to the specified value.
updatedAtGtdatetimeOptional
This will return items where the updatedAt is greater than the specified value.
updatedAtLtdatetimeOptional
This will return items where the updatedAt is less than the specified value.
updatedAtGedatetimeOptional
This will return items where the updatedAt is greater than or equal to the specified value.
updatedAtLedatetimeOptional
This will return items where the updatedAt is less than or equal to the specified value.

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.