Skip to main content
POST
/
v2
/
evaluate
/
trace
Evaluate Trace
curl --request POST \
  --url https://api.valiqor.com/v2/evaluate/trace \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_name": "<string>",
  "trace": {},
  "metrics": [
    "<string>"
  ],
  "run_name": "<string>",
  "config": {},
  "metadata": {},
  "openai_api_key": "<string>"
}
'
{
  "run_id": "<string>",
  "project_id": "<string>",
  "status": "<string>",
  "total_items": 123,
  "evaluated_items": 123,
  "overall_score": 123,
  "aggregate_scores": {},
  "metadata": {}
}

Authorizations

​
Authorization
string
header
required

Valiqor API key. Pass as Bearer token: Authorization: Bearer vq-xxxxxxxxxxxxxxxxxxxx

Body

application/json

Request model for trace-based evaluation endpoint

​
project_name
string
required

Project name (will be created if doesn't exist)

​
trace
Trace · object
required

Complete trace JSON data (with messages, spans, retrievals)

​
metrics
string[]
required

Metric keys to compute

​
run_name
string | null

Optional run name

​
config
Config · object

Evaluation configuration

​
metadata
Metadata · object

Additional metadata

​
openai_api_key
string | null

Optional OpenAI key override

Response

Successful Response

Response model for evaluation endpoint

​
run_id
string
required
​
project_id
string
required
​
status
string
required
​
total_items
integer
required
​
evaluated_items
integer
required
​
overall_score
number | null
required
​
aggregate_scores
Aggregate Scores · object
required
​
metadata
Metadata · object
required