Create guardrails for traces in a batch

POST/v1/private/guardrailsCreate guardrails for traces in a batch

Batch guardrails for traces

Request body

application/json

objectGuardrailBatch_Write

guardrailsarray of objectrequired

maxItems 1000 · minItems 1

Show child attributes

maxItems 1000 · minItems 1

Show array items

configobjectrequired

detailsobjectrequired

entity_idstring · uuidrequired

namestringrequired

one of "TOPIC", "PII", "LLM_JUDGE", "PROMPT_INJECTION", "CUSTOM_CLASSIFIER"

project_idstring · uuid

project_namestring

If null, the default project is used

pattern (?s)^\s*(\S.*\S|\S)\s*$

resultstringrequired

one of "passed", "failed"

secondary_idstring · uuidrequired

Example request

{
  "guardrails": [
    {
      "config": {},
      "details": {},
      "entity_id": "00000000-0000-0000-0000-000000000000",
      "name": "CUSTOM_CLASSIFIER",
      "project_id": "00000000-0000-0000-0000-000000000000",
      "project_name": "string",
      "result": "failed",
      "secondary_id": "00000000-0000-0000-0000-000000000000"
    }
  ]
}

Responses

Examples

curl -X POST 'http://localhost:5173/api/v1/private/guardrails' \
  -H 'Content-Type: application/json' \
  -d '{"guardrails":[{"config":{},"details":{},"entity_id":"00000000-0000-0000-0000-000000000000","name":"CUSTOM_CLASSIFIER","project_id":"00000000-0000-0000-0000-000000000000","project_name":"string","result":"failed","secondary_id":"00000000-0000-0000-0000-000000000000"}]}'

const response = await fetch('http://localhost:5173/api/v1/private/guardrails', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"guardrails":[{"config":{},"details":{},"entity_id":"00000000-0000-0000-0000-000000000000","name":"CUSTOM_CLASSIFIER","project_id":"00000000-0000-0000-0000-000000000000","project_name":"string","result":"failed","secondary_id":"00000000-0000-0000-0000-000000000000"}]}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/guardrails', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"guardrails\":[{\"config\":{},\"details\":{},\"entity_id\":\"00000000-0000-0000-0000-000000000000\",\"name\":\"CUSTOM_CLASSIFIER\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"result\":\"failed\",\"secondary_id\":\"00000000-0000-0000-0000-000000000000\"}]}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "http://localhost:5173/api/v1/private/guardrails",
    headers={"Content-Type": "application/json"},
    data='{"guardrails":[{"config":{},"details":{},"entity_id":"00000000-0000-0000-0000-000000000000","name":"CUSTOM_CLASSIFIER","project_id":"00000000-0000-0000-0000-000000000000","project_name":"string","result":"failed","secondary_id":"00000000-0000-0000-0000-000000000000"}]}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"guardrails":[{"config":{},"details":{},"entity_id":"00000000-0000-0000-0000-000000000000","name":"CUSTOM_CLASSIFIER","project_id":"00000000-0000-0000-0000-000000000000","project_name":"string","result":"failed","secondary_id":"00000000-0000-0000-0000-000000000000"}]}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/guardrails", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("http://localhost:5173/api/v1/private/guardrails");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"guardrails\":[{\"config\":{},\"details\":{},\"entity_id\":\"00000000-0000-0000-0000-000000000000\",\"name\":\"CUSTOM_CLASSIFIER\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"result\":\"failed\",\"secondary_id\":\"00000000-0000-0000-0000-000000000000\"}]}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/guardrails"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"guardrails\":[{\"config\":{},\"details\":{},\"entity_id\":\"00000000-0000-0000-0000-000000000000\",\"name\":\"CUSTOM_CLASSIFIER\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"result\":\"failed\",\"secondary_id\":\"00000000-0000-0000-0000-000000000000\"}]}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/guardrails")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"guardrails\":[{\"config\":{},\"details\":{},\"entity_id\":\"00000000-0000-0000-0000-000000000000\",\"name\":\"CUSTOM_CLASSIFIER\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"result\":\"failed\",\"secondary_id\":\"00000000-0000-0000-0000-000000000000\"}]}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:5173/api/v1/private/guardrails");
request.Content = new StringContent("{\"guardrails\":[{\"config\":{},\"details\":{},\"entity_id\":\"00000000-0000-0000-0000-000000000000\",\"name\":\"CUSTOM_CLASSIFIER\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"result\":\"failed\",\"secondary_id\":\"00000000-0000-0000-0000-000000000000\"}]}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

(no response body — HTTP 204)