@cavell/kit API
    Preparing search index...

    Interface ToolCall

    interface ToolCall {
        approvalId?: string;
        args: Record<string, unknown>;
        error?: string;
        executionMode: "sync" | "async";
        parametersSchema: Record<string, unknown>;
        pendingInteraction?: PendingInteraction;
        rawArgs?: string;
        rawResult?: string;
        requiresValidation: boolean;
        result?: Record<string, unknown>;
        status: ToolCallStatus;
        streamingAnswer?: string;
        streamingBlocks?: Block[];
        streamingCitations?: Citation[];
        streamingSearchContext?: SearchContext;
        toolCallId: string;
        toolName: string;
    }
    Index
    approvalId? args error? executionMode parametersSchema pendingInteraction? rawArgs? rawResult? requiresValidation result? status streamingAnswer? streamingBlocks? streamingCitations? streamingSearchContext? toolCallId toolName
    approvalId?: string

    The synthetic approval:* call id an approval decision must be sent back on.

    args: Record<string, unknown>
    error?: string
    executionMode: "sync" | "async"

    Always 'sync' on AG-UI — kept for component compatibility ('dispatched' rendering).

    parametersSchema: Record<string, unknown>
    pendingInteraction?: PendingInteraction

    Set when the tool has paused mid-execution to ask the user something.

    rawArgs?: string

    The wire-level argument string (may lag args while streaming) — feeds custom CopilotKit tool renderers and tool callbacks without re-serializing.

    rawResult?: string

    The wire-level TOOL_CALL_RESULT content string, unparsed.

    requiresValidation: boolean
    result?: Record<string, unknown>
    status: ToolCallStatus
    streamingAnswer?: string
    streamingBlocks?: Block[]

    Inline blocks (tables/figures) streamed live during execution, so [[cite:N]]/[[b:N]] embeds render in place as the answer streams.

    streamingCitations?: Citation[]

    Citations streamed live during execution (Ask Aletta), before the final result lands. Rendered eagerly so inline markers become clickable.

    streamingSearchContext?: SearchContext

    Search context streamed up front so the card shows the scope while the answer generates; on resume it instead comes from the persisted result.search_context.

    toolCallId: string

    AG-UI tool call id (the legacy model called this requestId).

    toolName: string

    Settings
    Member Visibility

    On This Page
    Properties