Skip to main content
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 '
{
  "name": "<string>",
  "description": "<string>",
  "status": "pending",
  "metadata": {},
  "results": {},
  "dataset_id": "<string>",
  "event_ids": [],
  "configuration": {},
  "evaluators": [],
  "session_ids": [],
  "datapoint_ids": [],
  "passing_ranges": {}
}
'
{
  "run_id": "<string>",
  "evaluation": "<unknown>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
​
description
string
​
status
enum<string>
default:pending
Available options:
pending,
completed,
failed,
cancelled,
running
​
metadata
object
​
results
object
​
dataset_id
string | null
​
event_ids
string[]
​
configuration
object
​
evaluators
any[]
​
session_ids
string[]
​
datapoint_ids
string[]
Minimum string length: 1
​
passing_ranges
object

Response

Successful response

​
run_id
string
required
​
evaluation
any