HoneyHive TypeScript API SDK
    Preparing search index...

    Type Alias CreateModelEventBatchRequest

    Request body for POST /events/model/batch

    type CreateModelEventBatchRequest = {
        is_single_session?: boolean;
        model_events: (
            {
                children_ids?: string[];
                config?: { [key: string]: unknown };
                cost?: unknown;
                duration?: number;
                end_time?: number;
                error?: string | null;
                event_id?: string;
                event_name?: string;
                event_type?: "model" | "tool" | "chain" | "session";
                feedback?: { [key: string]: unknown };
                hyperparameters?: { [key: string]: unknown };
                inputs?: { [key: string]: unknown };
                messages?: unknown[];
                metadata?: { [key: string]: unknown };
                metrics?: { [key: string]: unknown };
                model?: string;
                model_name?: string;
                model_version?: string;
                outputs?: { [key: string]: unknown };
                parent_id?: string;
                project?: string;
                project_id?: string;
                provider?: string;
                response?: unknown;
                response_format?: unknown;
                session_id?: string;
                source?: string;
                start_time?: number;
                template?: unknown;
                template_inputs?: unknown;
                tool_choice?: unknown;
                tools?: unknown;
                usage?: { [key: string]: unknown };
                user_properties?: { [key: string]: unknown };
            } & { [key: string]: unknown }
        )[];
        session?: {
            metadata?: { [key: string]: unknown };
            session_name?: string;
            start_time?: number;
            user_properties?: { [key: string]: unknown };
        } & { [key: string]: unknown };
        session_properties?: {
            metadata?: { [key: string]: unknown };
            session_name?: string;
            start_time?: number;
            user_properties?: { [key: string]: unknown };
        } & { [key: string]: unknown };
        single_session?: boolean;
    }
    Index

    Properties

    is_single_session? model_events session? session_properties? single_session?

    Properties

    is_single_session?: boolean

    Legacy field name for single_session (backward compatibility)

    model_events: (
        {
            children_ids?: string[];
            config?: { [key: string]: unknown };
            cost?: unknown;
            duration?: number;
            end_time?: number;
            error?: string | null;
            event_id?: string;
            event_name?: string;
            event_type?: "model" | "tool" | "chain" | "session";
            feedback?: { [key: string]: unknown };
            hyperparameters?: { [key: string]: unknown };
            inputs?: { [key: string]: unknown };
            messages?: unknown[];
            metadata?: { [key: string]: unknown };
            metrics?: { [key: string]: unknown };
            model?: string;
            model_name?: string;
            model_version?: string;
            outputs?: { [key: string]: unknown };
            parent_id?: string;
            project?: string;
            project_id?: string;
            provider?: string;
            response?: unknown;
            response_format?: unknown;
            session_id?: string;
            source?: string;
            start_time?: number;
            template?: unknown;
            template_inputs?: unknown;
            tool_choice?: unknown;
            tools?: unknown;
            usage?: { [key: string]: unknown };
            user_properties?: { [key: string]: unknown };
        } & { [key: string]: unknown }
    )[]

    Type Declaration

    • Optionalchildren_ids?: string[]

      Child event IDs in the trace hierarchy

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

      Configuration used for this event

    • Optionalcost?: unknown

      Legacy alias — remapped to inputs.cost

    • Optionalduration?: number

      Legacy alias — remapped to inputs.duration for model events

    • Optionalend_time?: number

      Event end time as Unix milliseconds

    • Optionalerror?: string | null

      Legacy alias — remapped to inputs.error for model events

    • Optionalevent_id?: string

      Unique event identifier

    • Optionalevent_name?: string

      Name of the event

    • Optionalevent_type?: "model" | "tool" | "chain" | "session"

      Type of event (model, tool, chain, or session)

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

      Feedback data associated with the event

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

      Legacy alias — remapped to inputs.hyperparameters

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

      Input data for the event

    • Optionalmessages?: unknown[]

      Legacy alias — remapped to inputs.messages

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

      Arbitrary metadata for the event

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

      Metric values computed for the event

    • Optionalmodel?: string

      Legacy alias for model_name

    • Optionalmodel_name?: string

      Model identifier (either this or event_name required)

    • Optionalmodel_version?: string

      Model version string

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

      Output data from the event

    • Optionalparent_id?: string

      Parent event ID in the trace hierarchy

    • Optionalproject?: string

      Project name (ignored by server — project is determined from API key scope)

    • Optionalproject_id?: string

      Project ID

    • Optionalprovider?: string

      Legacy alias — remapped to inputs.provider

    • Optionalresponse?: unknown

      Legacy alias — remapped to outputs.response

    • Optionalresponse_format?: unknown

      Legacy alias — remapped to inputs.response_format

    • Optionalsession_id?: string

      Session this event belongs to

    • Optionalsource?: string

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

    • Optionalstart_time?: number

      Event start time as Unix milliseconds

    • Optionaltemplate?: unknown

      Legacy alias — remapped to inputs.template

    • Optionaltemplate_inputs?: unknown

      Legacy alias — remapped to inputs.template_inputs

    • Optionaltool_choice?: unknown

      Legacy alias — remapped to inputs.tool_choice

    • Optionaltools?: unknown

      Legacy alias — remapped to inputs.tools

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

      Legacy alias — remapped to inputs.usage

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

      User properties associated with the event

    • [key: string]: unknown

    Array of model events to create

    session?: {
        metadata?: { [key: string]: unknown };
        session_name?: string;
        start_time?: number;
        user_properties?: { [key: string]: unknown };
    } & { [key: string]: unknown }

    Type Declaration

    • Optionalmetadata?: { [key: string]: unknown }
    • Optionalsession_name?: string
    • Optionalstart_time?: number

      Session start time as Unix milliseconds

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

    Alias for session_properties (backward compatibility)

    session_properties?: {
        metadata?: { [key: string]: unknown };
        session_name?: string;
        start_time?: number;
        user_properties?: { [key: string]: unknown };
    } & { [key: string]: unknown }

    Type Declaration

    • Optionalmetadata?: { [key: string]: unknown }
    • Optionalsession_name?: string
    • Optionalstart_time?: number

      Session start time as Unix milliseconds

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

    Session properties for batch event creation

    single_session?: boolean

    If true, all events share the same session

    Settings

    Member Visibility

    On This Page

    Properties