bothy-sdk
    Preparing search index...

    Interface BuildHeartbeatOptions

    The options of buildHeartbeat; each maps to the member of the same name.

    interface BuildHeartbeatOptions {
        billingEvidence?: {};
        billingModesSupported?: readonly ("personal" | "organization")[];
        details?: Readonly<Record<string, unknown>>;
        projectReadiness?: readonly {}[];
        rateLimit?: {};
        reportedBillingMode?: "personal" | "organization";
        reportedToolClass?: "host" | "chat" | "scoped";
        runtimeVersion?: string;
    }
    Index

    Properties

    billingEvidence? billingModesSupported? details? projectReadiness? rateLimit? reportedBillingMode? reportedToolClass? runtimeVersion?

    Properties

    billingEvidence?: {}

    billing_evidence: key_type (required), provider and method (codes); never a key value or prefix.

    billingModesSupported?: readonly ("personal" | "organization")[]

    billing_modes_supported: distinct modes the adapter can prove.

    details?: Readonly<Record<string, unknown>>

    The closed object details: capabilities (followups steer or queue; components, voice_input, title, files_out booleans), active_runs (distinct run IDs), degraded_reasons (distinct codes), adapter (name required, version optional), runtime (name required) and protocol_version (integer, at least 1).

    projectReadiness?: readonly {}[]

    project_readiness: runners only, one entry per bound forum, distinct channels.

    rateLimit?: {}

    rate_limit: the rate-limit state of the runtime at its provider (M6-14), state (ok, near_limit, limited or unknown) and optionally resets_at (an RFC 3339 time with a time zone); never a quota, key or subscription name. Leaving it out clears the state the server stored from an earlier heartbeat.

    reportedBillingMode?: "personal" | "organization"

    reported_billing_mode: personal or organization; leave it out when the adapter follows the configured mode per run.

    reportedToolClass?: "host" | "chat" | "scoped"

    reported_tool_class: the tool class the runtime actually loaded.

    runtimeVersion?: string

    runtime_version: version of the agent runtime, VERSION_FORM.

    Settings

    Member Visibility

    On This Page

    Properties