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
}

Sessions

Start a new session

Start a new session. The request body is a bare session object (no session wrapper). The server creates a session event and returns it.

No required properties — every field has a server-side fallback.

Auto-generated properties (provided by the server when omitted):

session_id (string, UUID) — Server generates a UUIDv4 if omitted or if the supplied value is not a valid UUID.

Optional properties with defaults:

event_name (string) — Falls back to session_name when not provided; defaults to "unknown" if both are absent.
source (string) — Defaults to "unknown".

Optional properties:

session_name (string) — Display name for the session.
start_time (number) — Session start time as Unix milliseconds. The session normalizer uses getInt64() which only accepts numeric types; if a string is passed, the server silently falls back to the current time.
end_time (number) — Session end time as Unix milliseconds (same numeric-only caveat as start_time).
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.
user_properties (object) — User properties.
children_ids (array of strings) — IDs of child events.

Idempotent on session_id: posting twice with the same session_id merges metadata/user_properties into the existing session and returns the existing event.

POST

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
}

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

Show child attributes

inputs

object

Input data for the session

Show child attributes

outputs

object

Output data from the session

Show child attributes

metadata

object

Arbitrary metadata for the session

Show child attributes

user_properties

object

User properties associated with the session

Show child attributes

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

Add traces to a session

Update an event (deprecated)

⌘I

Documentation Index

Authorizations

Body

Response