POST
/
runs
curl --request POST \
  --url https://api.honeyhive.ai/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
{
  "evaluation": {
    "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "project": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "event_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "dataset_id": "<string>",
    "datapoint_ids": [
      "<string>"
    ],
    "results": {},
    "configuration": {},
    "metadata": {},
    "status": "pending",
    "name": "<string>"
  },
  "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization
string
headerrequired

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

Body

application/json
project
string
required

The UUID of the project this run is associated with

name
string
required

The name of the run to be displayed

event_ids
string[]
required

The UUIDs of the sessions/events this run is associated with

dataset_id
string

The UUID of the dataset this run is associated with

datapoint_ids
string[]

The UUIDs of the datapoints from the original dataset this run is associated with

configuration
object

The configuration being used for this run

metadata
object

Additional metadata for the run

status
enum<string>

The status of the run

Available options:
pending,
completed

Response

200 - application/json
evaluation
object

The evaluation run created

run_id
string

The UUID of the run created