curl --request POST \
--url https://{instance}.omniapp.co/api/v1/ai/eval/runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"prompt_set_id": "550e8400-e29b-41d4-a716-446655440000",
"description": "Re-running after switching to gpt-4o for query generation",
"run_config": {
"branch_id": "440e8400-e29b-41d4-a716-446655440006"
}
}
'import requests
url = "https://{instance}.omniapp.co/api/v1/ai/eval/runs"
payload = {
"prompt_set_id": "550e8400-e29b-41d4-a716-446655440000",
"description": "Re-running after switching to gpt-4o for query generation",
"run_config": { "branch_id": "440e8400-e29b-41d4-a716-446655440006" }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
prompt_set_id: '550e8400-e29b-41d4-a716-446655440000',
description: 'Re-running after switching to gpt-4o for query generation',
run_config: {branch_id: '440e8400-e29b-41d4-a716-446655440006'}
})
};
fetch('https://{instance}.omniapp.co/api/v1/ai/eval/runs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{instance}.omniapp.co/api/v1/ai/eval/runs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'prompt_set_id' => '550e8400-e29b-41d4-a716-446655440000',
'description' => 'Re-running after switching to gpt-4o for query generation',
'run_config' => [
'branch_id' => '440e8400-e29b-41d4-a716-446655440006'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{instance}.omniapp.co/api/v1/ai/eval/runs"
payload := strings.NewReader("{\n \"prompt_set_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"description\": \"Re-running after switching to gpt-4o for query generation\",\n \"run_config\": {\n \"branch_id\": \"440e8400-e29b-41d4-a716-446655440006\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{instance}.omniapp.co/api/v1/ai/eval/runs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"prompt_set_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"description\": \"Re-running after switching to gpt-4o for query generation\",\n \"run_config\": {\n \"branch_id\": \"440e8400-e29b-41d4-a716-446655440006\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.omniapp.co/api/v1/ai/eval/runs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"prompt_set_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"description\": \"Re-running after switching to gpt-4o for query generation\",\n \"run_config\": {\n \"branch_id\": \"440e8400-e29b-41d4-a716-446655440006\"\n }\n}"
response = http.request(request)
puts response.read_body{
"job_count": 12,
"run": {
"branch_id": null,
"branch_name": null,
"completed_at": null,
"created_at": "2025-01-15T10:00:00.000Z",
"description": null,
"id": "660e8400-e29b-41d4-a716-446655440001",
"is_archived": false,
"model_id": "880e8400-e29b-41d4-a716-446655440003",
"prompt_set_id": "550e8400-e29b-41d4-a716-446655440000",
"results": [
{
"agentic_job": {
"conversation_id": "770e8400-e29b-41d4-a716-446655440002",
"id": "990e8400-e29b-41d4-a716-446655440004",
"state": "COMPLETE"
},
"cost": 0.0021,
"error_reason": null,
"id": "aa0e8400-e29b-41d4-a716-446655440005",
"prompt": "What are the top 5 products by revenue?",
"score": 0.9,
"scoring_cost": 0.0004,
"timing_ms": 4321
}
],
"run_number": 3,
"status": "RUNNING"
}
}{
"detail": "Bad Request: name: Required",
"status": 400
}{
"detail": "Unauthorized: Missing or invalid API key",
"status": 401
}{
"detail": "AI eval requires at least Querier access on the model",
"status": 403
}{
"detail": "Prompt set not found",
"status": 404
}{
"detail": "A prompt being updated does not belong to this prompt set",
"status": 422
}{
"detail": "Too many active runs; wait for an in-flight run to finish",
"status": 429
}{
"detail": "AI eval is paused for this organization",
"status": 503
}Start an eval run
Create and start a new run against an existing prompt set. The run enqueues one agentic job per prompt and begins executing immediately. Returns the newly created run with its initial per-prompt result rows.
curl --request POST \
--url https://{instance}.omniapp.co/api/v1/ai/eval/runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"prompt_set_id": "550e8400-e29b-41d4-a716-446655440000",
"description": "Re-running after switching to gpt-4o for query generation",
"run_config": {
"branch_id": "440e8400-e29b-41d4-a716-446655440006"
}
}
'import requests
url = "https://{instance}.omniapp.co/api/v1/ai/eval/runs"
payload = {
"prompt_set_id": "550e8400-e29b-41d4-a716-446655440000",
"description": "Re-running after switching to gpt-4o for query generation",
"run_config": { "branch_id": "440e8400-e29b-41d4-a716-446655440006" }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
prompt_set_id: '550e8400-e29b-41d4-a716-446655440000',
description: 'Re-running after switching to gpt-4o for query generation',
run_config: {branch_id: '440e8400-e29b-41d4-a716-446655440006'}
})
};
fetch('https://{instance}.omniapp.co/api/v1/ai/eval/runs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{instance}.omniapp.co/api/v1/ai/eval/runs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'prompt_set_id' => '550e8400-e29b-41d4-a716-446655440000',
'description' => 'Re-running after switching to gpt-4o for query generation',
'run_config' => [
'branch_id' => '440e8400-e29b-41d4-a716-446655440006'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{instance}.omniapp.co/api/v1/ai/eval/runs"
payload := strings.NewReader("{\n \"prompt_set_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"description\": \"Re-running after switching to gpt-4o for query generation\",\n \"run_config\": {\n \"branch_id\": \"440e8400-e29b-41d4-a716-446655440006\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{instance}.omniapp.co/api/v1/ai/eval/runs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"prompt_set_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"description\": \"Re-running after switching to gpt-4o for query generation\",\n \"run_config\": {\n \"branch_id\": \"440e8400-e29b-41d4-a716-446655440006\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.omniapp.co/api/v1/ai/eval/runs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"prompt_set_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"description\": \"Re-running after switching to gpt-4o for query generation\",\n \"run_config\": {\n \"branch_id\": \"440e8400-e29b-41d4-a716-446655440006\"\n }\n}"
response = http.request(request)
puts response.read_body{
"job_count": 12,
"run": {
"branch_id": null,
"branch_name": null,
"completed_at": null,
"created_at": "2025-01-15T10:00:00.000Z",
"description": null,
"id": "660e8400-e29b-41d4-a716-446655440001",
"is_archived": false,
"model_id": "880e8400-e29b-41d4-a716-446655440003",
"prompt_set_id": "550e8400-e29b-41d4-a716-446655440000",
"results": [
{
"agentic_job": {
"conversation_id": "770e8400-e29b-41d4-a716-446655440002",
"id": "990e8400-e29b-41d4-a716-446655440004",
"state": "COMPLETE"
},
"cost": 0.0021,
"error_reason": null,
"id": "aa0e8400-e29b-41d4-a716-446655440005",
"prompt": "What are the top 5 products by revenue?",
"score": 0.9,
"scoring_cost": 0.0004,
"timing_ms": 4321
}
],
"run_number": 3,
"status": "RUNNING"
}
}{
"detail": "Bad Request: name: Required",
"status": 400
}{
"detail": "Unauthorized: Missing or invalid API key",
"status": 401
}{
"detail": "AI eval requires at least Querier access on the model",
"status": 403
}{
"detail": "Prompt set not found",
"status": 404
}{
"detail": "A prompt being updated does not belong to this prompt set",
"status": 422
}{
"detail": "Too many active runs; wait for an in-flight run to finish",
"status": 429
}{
"detail": "AI eval is paused for this organization",
"status": 503
}Authorizations
Can be either an Organization API Key or Personal Access Token (PAT).
Include in the Authorization header as: Bearer YOUR_TOKEN
Body
The prompt set to execute.
"550e8400-e29b-41d4-a716-446655440000"
Optional human-readable description for the run. Omit or pass null to leave it unset. Max 1024 characters.
1024"Re-running after switching to gpt-4o for query generation"
Per-run configuration. Optional — omit if no overrides.
Show child attributes
Show child attributes
Response
Run created and jobs enqueued.
Number of per-prompt agentic jobs created for this run (one per prompt that fanned out successfully). Enqueue onto the work queue happens after creation and is best-effort, so this count reflects jobs created, not necessarily those successfully enqueued.
12
The newly created run with its initial results.
Show child attributes
Show child attributes
Was this page helpful?

