Create a new evaluation run
curl --request POST \
--url https://api.honeyhive.ai/v1/runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"run_id": "<string>",
"name": "<string>",
"description": "<string>",
"status": "pending",
"metadata": {},
"results": {},
"dataset_id": "<string>",
"event_ids": [],
"configuration": {},
"evaluators": [],
"session_ids": [],
"datapoint_ids": [],
"passing_ranges": {}
}
'import requests
url = "https://api.honeyhive.ai/v1/runs"
payload = {
"run_id": "<string>",
"name": "<string>",
"description": "<string>",
"status": "pending",
"metadata": {},
"results": {},
"dataset_id": "<string>",
"event_ids": [],
"configuration": {},
"evaluators": [],
"session_ids": [],
"datapoint_ids": [],
"passing_ranges": {}
}
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({
run_id: '<string>',
name: '<string>',
description: '<string>',
status: 'pending',
metadata: {},
results: {},
dataset_id: '<string>',
event_ids: [],
configuration: {},
evaluators: [],
session_ids: [],
datapoint_ids: [],
passing_ranges: {}
})
};
fetch('https://api.honeyhive.ai/v1/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://api.honeyhive.ai/v1/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([
'run_id' => '<string>',
'name' => '<string>',
'description' => '<string>',
'status' => 'pending',
'metadata' => [
],
'results' => [
],
'dataset_id' => '<string>',
'event_ids' => [
],
'configuration' => [
],
'evaluators' => [
],
'session_ids' => [
],
'datapoint_ids' => [
],
'passing_ranges' => [
]
]),
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://api.honeyhive.ai/v1/runs"
payload := strings.NewReader("{\n \"run_id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"status\": \"pending\",\n \"metadata\": {},\n \"results\": {},\n \"dataset_id\": \"<string>\",\n \"event_ids\": [],\n \"configuration\": {},\n \"evaluators\": [],\n \"session_ids\": [],\n \"datapoint_ids\": [],\n \"passing_ranges\": {}\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://api.honeyhive.ai/v1/runs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"run_id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"status\": \"pending\",\n \"metadata\": {},\n \"results\": {},\n \"dataset_id\": \"<string>\",\n \"event_ids\": [],\n \"configuration\": {},\n \"evaluators\": [],\n \"session_ids\": [],\n \"datapoint_ids\": [],\n \"passing_ranges\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.honeyhive.ai/v1/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 \"run_id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"status\": \"pending\",\n \"metadata\": {},\n \"results\": {},\n \"dataset_id\": \"<string>\",\n \"event_ids\": [],\n \"configuration\": {},\n \"evaluators\": [],\n \"session_ids\": [],\n \"datapoint_ids\": [],\n \"passing_ranges\": {}\n}"
response = http.request(request)
puts response.read_body{
"evaluation": {
"id": "<string>",
"run_id": "<string>",
"metadata": {},
"results": {},
"event_ids": [
"<string>"
],
"configuration": {},
"is_active": true,
"created_at": "<string>",
"scope_type": "<string>",
"scope_id": "<string>",
"name": "<string>",
"description": "<string>",
"status": "<string>",
"metrics": {},
"updated_at": "<string>",
"dataset_id": "<string>"
},
"run_id": "<string>"
}Experiments
Create a new evaluation run
Create a new experiment run to track an evaluation against a dataset.
POST
/
v1
/
runs
Create a new evaluation run
curl --request POST \
--url https://api.honeyhive.ai/v1/runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"run_id": "<string>",
"name": "<string>",
"description": "<string>",
"status": "pending",
"metadata": {},
"results": {},
"dataset_id": "<string>",
"event_ids": [],
"configuration": {},
"evaluators": [],
"session_ids": [],
"datapoint_ids": [],
"passing_ranges": {}
}
'import requests
url = "https://api.honeyhive.ai/v1/runs"
payload = {
"run_id": "<string>",
"name": "<string>",
"description": "<string>",
"status": "pending",
"metadata": {},
"results": {},
"dataset_id": "<string>",
"event_ids": [],
"configuration": {},
"evaluators": [],
"session_ids": [],
"datapoint_ids": [],
"passing_ranges": {}
}
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({
run_id: '<string>',
name: '<string>',
description: '<string>',
status: 'pending',
metadata: {},
results: {},
dataset_id: '<string>',
event_ids: [],
configuration: {},
evaluators: [],
session_ids: [],
datapoint_ids: [],
passing_ranges: {}
})
};
fetch('https://api.honeyhive.ai/v1/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://api.honeyhive.ai/v1/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([
'run_id' => '<string>',
'name' => '<string>',
'description' => '<string>',
'status' => 'pending',
'metadata' => [
],
'results' => [
],
'dataset_id' => '<string>',
'event_ids' => [
],
'configuration' => [
],
'evaluators' => [
],
'session_ids' => [
],
'datapoint_ids' => [
],
'passing_ranges' => [
]
]),
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://api.honeyhive.ai/v1/runs"
payload := strings.NewReader("{\n \"run_id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"status\": \"pending\",\n \"metadata\": {},\n \"results\": {},\n \"dataset_id\": \"<string>\",\n \"event_ids\": [],\n \"configuration\": {},\n \"evaluators\": [],\n \"session_ids\": [],\n \"datapoint_ids\": [],\n \"passing_ranges\": {}\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://api.honeyhive.ai/v1/runs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"run_id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"status\": \"pending\",\n \"metadata\": {},\n \"results\": {},\n \"dataset_id\": \"<string>\",\n \"event_ids\": [],\n \"configuration\": {},\n \"evaluators\": [],\n \"session_ids\": [],\n \"datapoint_ids\": [],\n \"passing_ranges\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.honeyhive.ai/v1/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 \"run_id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"status\": \"pending\",\n \"metadata\": {},\n \"results\": {},\n \"dataset_id\": \"<string>\",\n \"event_ids\": [],\n \"configuration\": {},\n \"evaluators\": [],\n \"session_ids\": [],\n \"datapoint_ids\": [],\n \"passing_ranges\": {}\n}"
response = http.request(request)
puts response.read_body{
"evaluation": {
"id": "<string>",
"run_id": "<string>",
"metadata": {},
"results": {},
"event_ids": [
"<string>"
],
"configuration": {},
"is_active": true,
"created_at": "<string>",
"scope_type": "<string>",
"scope_id": "<string>",
"name": "<string>",
"description": "<string>",
"status": "<string>",
"metrics": {},
"updated_at": "<string>",
"dataset_id": "<string>"
},
"run_id": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Request body for POST /runs
Available options:
pending, completed, failed, cancelled, running Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Minimum string length:
1Show child attributes
Show child attributes
Was this page helpful?
⌘I

