Member Junction
    Preparing search index...

    Interface AssemblyAIServerEvent

    A parsed inbound websocket frame. The Voice Agent protocol multiplexes on type.

    interface AssemblyAIServerEvent {
        arguments?: JSONObject;
        call_id?: string;
        code?: string;
        data?: string;
        interrupted?: boolean;
        item_id?: string;
        message?: string;
        name?: string;
        param?: string;
        reply_id?: string;
        session?: JSONObject;
        session_duration_seconds?: number;
        session_id?: string;
        status?: string;
        text?: string;
        type?: string;
    }
    Index

    Properties

    arguments? call_id? code? data? interrupted? item_id? message? name? param? reply_id? session? session_duration_seconds? session_id? status? text? type?

    Properties

    arguments?: JSONObject

    tool.call — the arguments, ALREADY PARSED into an object by the provider.

    call_id?: string

    tool.call — correlation id the result must echo.

    code?: string

    session.error — provider error code.

    data?: string

    reply.audio — one base64 PCM16 chunk of the agent's spoken output.

    interrupted?: boolean

    transcript.agent — true when the turn was cut off by a barge-in.

    item_id?: string

    transcript.* — provider conversation-item id.

    message?: string

    session.error — human-readable error message.

    name?: string

    tool.call — the tool name.

    param?: string

    session.error — the offending parameter, when applicable.

    reply_id?: string

    reply.started / transcript.agent — id of the reply the frame belongs to.

    session?: JSONObject

    session.updated — echo of the applied session object.

    session_duration_seconds?: number

    session.ended — total billable session seconds.

    session_id?: string

    session.ready — the provider-assigned session id.

    status?: string

    reply.done — 'interrupted' when the user barged in mid-reply; absent otherwise.

    Optionaltext

    text?: string

    transcript.user[.delta] / transcript.agent — the transcribed text.

    type?: string

    Settings

    Member Visibility

    On This Page

    Properties