D-ID Client SDK - v3.0.0-0
    Preparing search index...

    Interface ToolCallStartedPayload

    The payload of a ToolCallEvent.Started event: the agent has begun a tool call.

    Delivered to onToolEvent — see ToolEventCallback.

    interface ToolCallStartedPayload {
        callId: string;
        executionMode: ToolExecutionMode;
        input: Record<string, unknown>;
        interruptible: boolean;
        name: string;
        output?: Record<string, unknown>;
        timestamp: string;
        turnId?: number | null;
    }
    Index
    callId: string

    Id of this call. The matching done or error payload carries the same id.

    executionMode: ToolExecutionMode

    Whether the agent waits for this call. See ToolExecutionMode.

    Always present: a server event that omits it, or carries anything other than async, is reported as 'blocking' — the same normalization RunningToolCall.executionMode applies, so the two agree about the same call.

    input: Record<string, unknown>

    The arguments the agent's LLM produced for this call.

    interruptible: boolean

    Whether the server considers the agent interruptible while this call is outstanding.

    Informational: the SDK does not forward it. onInterruptibleChange is derived from the executionMode of the calls still running, not from this field.

    name: string

    Name of the tool the agent is calling, as configured on the agent.

    output?: Record<string, unknown>

    The tool's result, when the server sent one.

    The event is emitted before the tool has run, so it is normally absent; read the output of the matching done event instead.

    timestamp: string

    When the call started, as reported by the server.

    turnId?: number | null

    The conversational turn this call belongs to, or null when it belongs to no turn.