Skip to main content
POST
/
v1
/
sessions
Start a new session
curl --request POST \
  --url https://api.dp1.us.honeyhive.ai/v1/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "session_id": "<string>",
  "session_name": "<string>",
  "event_name": "<string>",
  "source": "<string>",
  "start_time": 123,
  "end_time": 123,
  "duration": 123,
  "config": {},
  "inputs": {},
  "outputs": {},
  "metadata": {},
  "user_properties": {},
  "children_ids": [
    "<string>"
  ]
}
'
{
  "event_id": "<string>",
  "session_id": "<string>",
  "org_id": "<string>",
  "workspace_id": "<string>",
  "project_id": "<string>",
  "parent_id": "<string>",
  "children_ids": [
    "<string>"
  ],
  "event_type": "<string>",
  "event_name": "<string>",
  "config": "<unknown>",
  "inputs": "<unknown>",
  "outputs": "<unknown>",
  "error": "<string>",
  "source": "<string>",
  "duration": 123,
  "user_properties": "<unknown>",
  "metrics": "<unknown>",
  "feedback": "<unknown>",
  "metadata": "<unknown>",
  "start_time": 123,
  "end_time": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.honeyhive.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

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

Body

application/json

Request body for POST /v1/sessions (bare session object)

session_id
string

Client-provided session ID (server generates one if omitted)

session_name
string

Display name for the session

event_name
string

Fallback name if session_name is not provided

source
string

Source of the session (e.g., sdk-python)

start_time
number

Session start time as Unix milliseconds

end_time
number

Session end time as Unix milliseconds

duration
number

Session duration in milliseconds

config
object

Configuration associated with the session

inputs
object

Input data for the session

outputs
object

Output data from the session

metadata
object

Arbitrary metadata for the session

user_properties
object

User properties associated with the session

children_ids
string[]

IDs of child events in this session

Response

Session successfully started

Full session event object returned after starting a new session

event_id
string
required
session_id
string
required
org_id
string
required
workspace_id
string
required
project_id
string
required
parent_id
string | null
children_ids
string[]
event_type
string | null
event_name
string | null
config
any
inputs
any
outputs
any
error
string | null
source
string | null
duration
number | null
user_properties
any
metrics
any
feedback
any
metadata
any
start_time
number | null
end_time
number | null
{key}
any