HoneyHive TypeScript API SDK
    Preparing search index...

    Type Alias StartSessionRequest

    Request to start a new session

    type StartSessionRequest = {
        session: {
            children_ids?: string[];
            config?: { [key: string]: unknown };
            duration?: number;
            end_time?: number;
            event_name?: string;
            inputs?: { [key: string]: unknown };
            metadata?: { [key: string]: unknown };
            outputs?: { [key: string]: unknown };
            session_id?: string;
            session_name?: string;
            source?: string;
            start_time?: number;
            user_properties?: { [key: string]: unknown };
        } & { [key: string]: unknown };
    }
    Index

    Properties

    session

    Properties

    session: {
        children_ids?: string[];
        config?: { [key: string]: unknown };
        duration?: number;
        end_time?: number;
        event_name?: string;
        inputs?: { [key: string]: unknown };
        metadata?: { [key: string]: unknown };
        outputs?: { [key: string]: unknown };
        session_id?: string;
        session_name?: string;
        source?: string;
        start_time?: number;
        user_properties?: { [key: string]: unknown };
    } & { [key: string]: unknown }

    Type Declaration

    • Optionalchildren_ids?: string[]

      IDs of child events in this session

    • Optionalconfig?: { [key: string]: unknown }

      Configuration associated with the session

    • Optionalduration?: number

      Session duration in milliseconds

    • Optionalend_time?: number

      Session end time as Unix milliseconds

    • Optionalevent_name?: string

      Fallback name if session_name is not provided

    • Optionalinputs?: { [key: string]: unknown }

      Input data for the session

    • Optionalmetadata?: { [key: string]: unknown }

      Arbitrary metadata for the session

    • Optionaloutputs?: { [key: string]: unknown }

      Output data from the session

    • Optionalsession_id?: string

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

    • Optionalsession_name?: string

      Display name for the session

    • Optionalsource?: string

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

    • Optionalstart_time?: number

      Session start time as Unix milliseconds

    • Optionaluser_properties?: { [key: string]: unknown }

      User properties associated with the session

    • [key: string]: unknown

    Settings

    Member Visibility

    On This Page

    Properties