Manually evaluate traces | Opik Documentation

POST/v1/private/manual-evaluation/tracesManually evaluate traces

Manually trigger evaluation rules on selected traces. Bypasses sampling and enqueues all specified traces for evaluation.

Request body

application/json

objectManualEvaluationRequest

entity_idsarray of string · uuidrequired

List of entity IDs (trace IDs or thread IDs) to evaluate

minItems 1

Show child attributes

minItems 1

entity_typestringrequired

Type of entity to evaluate (trace or thread)

one of "trace", "thread", "span"

project_idstring · uuidrequired

Project ID

rule_idsarray of string · uuidrequired

List of automation rule IDs to apply

minItems 1

Show child attributes

minItems 1

Example request

{
  "entity_ids": [
    "550e8400-e29b-41d4-a716-446655440000",
    "550e8400-e29b-41d4-a716-446655440001"
  ],
  "entity_type": "trace",
  "project_id": "550e8400-e29b-41d4-a716-446655440000",
  "rule_ids": [
    "660e8400-e29b-41d4-a716-446655440000"
  ]
}

Responses

objectManualEvaluationResponse

entities_queuedinteger · int32

Number of entities queued for evaluation

rules_appliedinteger · int32

Number of rules that will be applied

Example response

{
  "entities_queued": 5,
  "rules_applied": 2
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

Examples

curl -X POST 'http://localhost:5173/api/v1/private/manual-evaluation/traces' \
  -H 'Content-Type: application/json' \
  -d '{"entity_ids":["550e8400-e29b-41d4-a716-446655440000","550e8400-e29b-41d4-a716-446655440001"],"entity_type":"trace","project_id":"550e8400-e29b-41d4-a716-446655440000","rule_ids":["660e8400-e29b-41d4-a716-446655440000"]}'

const response = await fetch('http://localhost:5173/api/v1/private/manual-evaluation/traces', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"entity_ids":["550e8400-e29b-41d4-a716-446655440000","550e8400-e29b-41d4-a716-446655440001"],"entity_type":"trace","project_id":"550e8400-e29b-41d4-a716-446655440000","rule_ids":["660e8400-e29b-41d4-a716-446655440000"]}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/manual-evaluation/traces', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"entity_ids\":[\"550e8400-e29b-41d4-a716-446655440000\",\"550e8400-e29b-41d4-a716-446655440001\"],\"entity_type\":\"trace\",\"project_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"rule_ids\":[\"660e8400-e29b-41d4-a716-446655440000\"]}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "http://localhost:5173/api/v1/private/manual-evaluation/traces",
    headers={"Content-Type": "application/json"},
    data='{"entity_ids":["550e8400-e29b-41d4-a716-446655440000","550e8400-e29b-41d4-a716-446655440001"],"entity_type":"trace","project_id":"550e8400-e29b-41d4-a716-446655440000","rule_ids":["660e8400-e29b-41d4-a716-446655440000"]}',
)
print(response.json())

package main

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

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"entity_ids":["550e8400-e29b-41d4-a716-446655440000","550e8400-e29b-41d4-a716-446655440001"],"entity_type":"trace","project_id":"550e8400-e29b-41d4-a716-446655440000","rule_ids":["660e8400-e29b-41d4-a716-446655440000"]}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/manual-evaluation/traces", 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/manual-evaluation/traces");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"entity_ids\":[\"550e8400-e29b-41d4-a716-446655440000\",\"550e8400-e29b-41d4-a716-446655440001\"],\"entity_type\":\"trace\",\"project_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"rule_ids\":[\"660e8400-e29b-41d4-a716-446655440000\"]}");
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/manual-evaluation/traces"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"entity_ids\":[\"550e8400-e29b-41d4-a716-446655440000\",\"550e8400-e29b-41d4-a716-446655440001\"],\"entity_type\":\"trace\",\"project_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"rule_ids\":[\"660e8400-e29b-41d4-a716-446655440000\"]}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/manual-evaluation/traces")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"entity_ids\":[\"550e8400-e29b-41d4-a716-446655440000\",\"550e8400-e29b-41d4-a716-446655440001\"],\"entity_type\":\"trace\",\"project_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"rule_ids\":[\"660e8400-e29b-41d4-a716-446655440000\"]}"
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/manual-evaluation/traces");
request.Content = new StringContent("{\"entity_ids\":[\"550e8400-e29b-41d4-a716-446655440000\",\"550e8400-e29b-41d4-a716-446655440001\"],\"entity_type\":\"trace\",\"project_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"rule_ids\":[\"660e8400-e29b-41d4-a716-446655440000\"]}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "entities_queued": 5,
  "rules_applied": 2
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}