@pouchy_ai/companion-sdk - v0.1.0
    Preparing search index...

    Interface ToolCallPayload

    Payload of a companion.tool_call event — the companion is asking the host to run one of the app-declared tools it was given at hello. args is the raw JSON string the model produced (parse it yourself); reply by posting the result back with client.sendToolResult(id, …).

    interface ToolCallPayload {
        args: string;
        id: string;
        name: string;
        replayed?: boolean;
    }

    Hierarchy (View Summary)

    Index
    args id name replayed?
    args: string

    The model's arguments as a raw JSON string.

    id: string

    Correlation id — echo it back on the tool result.

    name: string

    The declared tool name the model chose.

    replayed?: boolean

    True when this delivery is a REPLAY of a still-outstanding call from a turn that paused before a reconnect (see hello.ack pendingToolCalls) — the app may have already performed it and crashed before posting the result. Side-effecting tools should treat id as an idempotency key. Absent on the original live delivery.

    Settings
    Member Visibility

    On This Page
    Properties