Member Junction
    Preparing search index...

    Interface InworldServerEvent

    A parsed inbound Inworld Realtime WebSocket frame.

    The Inworld protocol multiplexes server events on a type discriminator (mirroring the session.update request shape it accepts), so a single interface carries every inbound field the driver reads. Fields are optional because which ones are present depends on type.

    Wire-format binding point — the precise inbound type strings and field names are mapped to the documented protocol shape and centralized in InworldRealtimeSession.classifyServerEvent; verify the exact discriminators against a live Inworld endpoint.

    interface InworldServerEvent {
        arguments?: JSONValue;
        audio?: string;
        call_id?: string;
        code?: string;
        fatal?: boolean;
        input_tokens?: number;
        message?: string;
        name?: string;
        output_tokens?: number;
        session_id?: string;
        text?: string;
        type?: string;
    }
    Index

    Properties

    arguments? audio? call_id? code? fatal? input_tokens? message? name? output_tokens? session_id? text? type?

    Properties

    arguments?: JSONValue

    Tool-call arguments. Inworld may emit these either pre-parsed (object) or as a JSON string; the driver normalizes both to the Core contract's JSON-string Arguments shape.

    audio?: string

    A base64-encoded chunk of synthesized output audio (Realtime TTS-2).

    call_id?: string

    A correlation id for a tool call, echoed back on the tool result.

    code?: string

    Provider error code on an error frame.

    fatal?: boolean

    Whether the provider classified an error frame as fatal (transport/credential death).

    input_tokens?: number

    Incremental input-token count on a usage frame.

    message?: string

    Human-readable message on an error frame.

    name?: string

    The tool name on a tool-call frame.

    output_tokens?: number

    Incremental output-token count on a usage frame.

    session_id?: string

    Provider-assigned session id, surfaced on the session-ready frame.

    Optionaltext

    text?: string

    Transcribed text for a transcript frame (user STT or assistant TTS transcript).

    type?: string

    The event discriminator (e.g. session.updated, output_audio.delta, response.done).

    Settings

    Member Visibility

    On This Page

    Properties