bothy-sdk
    Preparing search index...

    Interface AdapterConfig

    Configuration of an agent adapter.

    interface AdapterConfig {
        adapterName?: string;
        adapterVersion?: string;
        agentId: string;
        allowlist?: boolean;
        baseUrl: string;
        capabilities?: Readonly<Record<string, unknown>>;
        commands?: readonly CommandSpec[];
        consumer: string;
        credentials: Credentials;
        instanceId: string;
        runtimeName?: string;
        runtimeVersion?: string;
        settings?: Partial<SdkSettings>;
        stateDir?: string;
        transport?: "gateway" | "polling";
    }
    Index

    Properties

    adapterName? adapterVersion? agentId allowlist? baseUrl capabilities? commands? consumer credentials instanceId runtimeName? runtimeVersion? settings? stateDir? transport?

    Properties

    adapterName?: string

    The adapter's name (heartbeat, User-Agent); default bothy-adapter.

    adapterVersion?: string

    The adapter's version; default 0.0.0.

    agentId: string

    The agent's principal ID (aud).

    allowlist?: boolean

    true to keep the allow list of 17.7 (getAgentTriggerers).

    baseUrl: string

    The API base, for example https://example.com/api/v1.

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

    The heartbeat capabilities (09 4.8).

    commands?: readonly CommandSpec[]

    Declared commands, reconciled after every connect; absent leaves commands alone.

    consumer: string

    The consumer name.

    credentials: Credentials

    The agent's API token and optional DPoP key.

    instanceId: string

    The configured instance (iss of every token, 09 4.5 point 4); never from discovery.

    runtimeName?: string

    The runtime's name (heartbeat); default runtime.

    runtimeVersion?: string

    The runtime's version, if known.

    settings?: Partial<SdkSettings>

    Overrides of the SDK settings.

    stateDir?: string

    The directory of the inbox (inbox/) and the outbox (outbox.json); absent keeps both in memory (tests only, not durable).

    transport?: "gateway" | "polling"

    gateway (default) or polling.

    Settings

    Member Visibility

    On This Page

    Properties