Skip to main content
POST
/
session
/
start
Start a new session
curl --request POST \
  --url https://api.honeyhive.ai/session/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "session": "<string>"
}
'
{
  "org_id": "<string>",
  "workspace_id": "<string>",
  "project_id": "<string>",
  "event_id": "<string>",
  "session_id": "<string>",
  "parent_id": "<string>",
  "children_ids": [],
  "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
}

Authorizations

Authorization
string
header
required

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

Body

application/json
session
string
required

JSON-encoded session object containing session properties (session_id, project, session_name, source, user_properties, etc.)

Response

200 - application/json

Session successfully started

Full session event object returned after starting a new session

org_id
string
required
workspace_id
string
required
project_id
string
required
event_id
string | null
session_id
string | null
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