Skip to main content
POST
/
runs
Python
import honeyhive
from honeyhive.models import components

s = honeyhive.HoneyHive(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)


res = s.runs.create_run(request=components.CreateRunRequest(
    project='<value>',
    name='<value>',
    event_ids=[
        '1b590040-fd4d-40db-a8d8-d6e550cfa9f3',
    ],
))

if res.create_run_response is not None:
    # handle response
    pass
{
  "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
header
required

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<uuid>[]
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

Successful response

​
evaluation
object

The evaluation run created

​
run_id
string<uuid>

The UUID of the run created