Skip to navigation
Platform APICustom Guardrails

List custom guardrails

List the custom guardrails of your organization. Use the returned id values in custom_guardrail_ids when you create or update a policy.

The response contains the ID, name, description and last edit time of each guardrail, not its rules. Create and edit guardrails in the AI Guardrails Dashboard.

Authentication

AuthorizationBearer

Bearer authentication using API key. Generate an API key from the AI Guardrails Dashboard. Example: Bearer sk_123…

Keys carry one of two access scopes, chosen when the key is created:

  • Read and write — may call every endpoint. This is the default, and the scope of every key created before scopes were introduced.
  • Read only — may call read endpoints such as /v1-beta/logs, /v1-beta/analytics and the GET endpoints. Write endpoints return 403.

Issue a read-only key to anything that only needs to retrieve data, such as a log-shipping job or a dashboard, so that it cannot modify your policies or projects.

Response

The custom guardrails of your organization, sorted by name
custom_guardrailslist of objects
The custom guardrails of your organization, sorted by name

Errors

400
Bad Request Error
403
Forbidden Error