For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Copy to LLM Github Go to App

Documentation Integrations Cost Intelligence Self-hosting Opik SDK & API reference

Skip to navigation

Rest API API Reference Guardrails

Create guardrails for traces in a batch

||View as Markdown|

POST

/v1/private/guardrails

POST

/api/v1/private/guardrails

curl -X POST http://localhost:5173/api/v1/private/guardrails \
     -H "Content-Type: application/json" \
     -d '{
  "guardrails": [
    {
      "entity_id": "string",
      "secondary_id": "string",
      "name": "TOPIC",
      "result": "passed",
      "config": {},
      "details": {}
    }
  ]
}'

204No Content

Batch guardrails for traces

Request

This endpoint expects an object.

guardrailslist of objectsRequired

Response

No Content

Was this page helpful?

Find insights views

Documentation Integrations Cost Intelligence Self-hosting Opik SDK & API reference

- Overview
Python SDK
Typescript SDK
Rest API
- Overview