> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://www.comet.com/docs/opik/reference/rest-api/guardrails/create-guardrails/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://www.comet.com/_mcp/server. # Create guardrails for traces in a batch POST http://localhost:5173/api/v1/private/guardrails Content-Type: application/json Batch guardrails for traces Reference: https://www.comet.com/docs/opik/reference/rest-api/guardrails/create-guardrails ## Servers - `http://localhost:5173/api` (Local server, default) - `https://www.comet.com/opik/api` (Opik Cloud) ## Request ### Body (application/json) This endpoint expects a GuardrailBatch_Write. - `guardrails` (list of Guardrail_Write, required) ## Response ### 204 No Content ## Types ### Guardrail_Write - `entity_id` (string, required) - `secondary_id` (string, required) - `name` (enum, required) - Allowed values: `TOPIC`, `PII`, `LLM_JUDGE`, `PROMPT_INJECTION`, `CUSTOM_CLASSIFIER` - `result` (enum, required) - Allowed values: `passed`, `failed` - `config` (JsonNode, required) - `details` (JsonNode, required) - `project_name` (string, optional) — If null, the default project is used - `project_id` (string, optional) ### JsonNode ## Examples **Request** ```json { "guardrails": [ { "entity_id": "string", "secondary_id": "string", "name": "TOPIC", "result": "passed", "config": {}, "details": {} } ] } ``` **SDK Code** ```python import requests url = "http://localhost:5173/api/v1/private/guardrails" payload = { "guardrails": [ { "entity_id": "string", "secondary_id": "string", "name": "TOPIC", "result": "passed", "config": {}, "details": {} } ] } headers = {"Content-Type": "application/json"} response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'http://localhost:5173/api/v1/private/guardrails'; const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"guardrails":[{"entity_id":"string","secondary_id":"string","name":"TOPIC","result":"passed","config":{},"details":{}}]}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "http://localhost:5173/api/v1/private/guardrails" payload := strings.NewReader("{\n \"guardrails\": [\n {\n \"entity_id\": \"string\",\n \"secondary_id\": \"string\",\n \"name\": \"TOPIC\",\n \"result\": \"passed\",\n \"config\": {},\n \"details\": {}\n }\n ]\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("http://localhost:5173/api/v1/private/guardrails") http = Net::HTTP.new(url.host, url.port) request = Net::HTTP::Post.new(url) request["Content-Type"] = 'application/json' request.body = "{\n \"guardrails\": [\n {\n \"entity_id\": \"string\",\n \"secondary_id\": \"string\",\n \"name\": \"TOPIC\",\n \"result\": \"passed\",\n \"config\": {},\n \"details\": {}\n }\n ]\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("http://localhost:5173/api/v1/private/guardrails") .header("Content-Type", "application/json") .body("{\n \"guardrails\": [\n {\n \"entity_id\": \"string\",\n \"secondary_id\": \"string\",\n \"name\": \"TOPIC\",\n \"result\": \"passed\",\n \"config\": {},\n \"details\": {}\n }\n ]\n}") .asString(); ``` ```php request('POST', 'http://localhost:5173/api/v1/private/guardrails', [ 'body' => '{ "guardrails": [ { "entity_id": "string", "secondary_id": "string", "name": "TOPIC", "result": "passed", "config": {}, "details": {} } ] }', 'headers' => [ 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("http://localhost:5173/api/v1/private/guardrails"); var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"guardrails\": [\n {\n \"entity_id\": \"string\",\n \"secondary_id\": \"string\",\n \"name\": \"TOPIC\",\n \"result\": \"passed\",\n \"config\": {},\n \"details\": {}\n }\n ]\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Content-Type": "application/json"] let parameters = ["guardrails": [ [ "entity_id": "string", "secondary_id": "string", "name": "TOPIC", "result": "passed", "config": [], "details": [] ] ]] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:5173/api/v1/private/guardrails")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ``` > Debug, evaluate, and monitor your LLM applications, RAG systems, and agentic workflows with comprehensive tracing, automated evaluations, and production-ready dashboards.