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

    Interface UsagePayload

    Payload of a control.usage event — a per-turn metering echo the host can surface in a usage/billing view. Emitted after a companion input turn that billed tokens, carrying the same whole-turn totals as the input done frame's usage block; subscribe via client.onUsage(...). All fields optional.

    interface UsagePayload {
        cachedTokens?: number;
        chatTurns?: number;
        completionTokens?: number;
        memoryOps?: number;
        model?: string;
        promptTokens?: number;
        reasoningTokens?: number;
        voiceSeconds?: number;
    }
    Index
    cachedTokens? chatTurns? completionTokens? memoryOps? model? promptTokens? reasoningTokens? voiceSeconds?
    cachedTokens?: number

    Whole-turn prefix-cache hits.

    chatTurns?: number
    completionTokens?: number

    Whole-turn completion tokens (inclusive of reasoningTokens).

    memoryOps?: number
    model?: string

    The served model of the final billed hop (fallback-aware), when known.

    promptTokens?: number

    Whole-turn prompt tokens (sum across hops).

    reasoningTokens?: number

    Reasoning tokens — a subset of completionTokens, not additive; present only when the served model reports it.

    voiceSeconds?: number

    Settings
    Member Visibility

    On This Page
    Properties