OpenClaw SDK
    Preparing search index...

    Interface ClientConfig

    Configuration for the OpenClaw client.

    interface ClientConfig {
        url: string;
        clientId: string;
        clientVersion?: string;
        platform?: string;
        deviceFamily?: string;
        modelIdentifier?: string;
        mode?: string;
        instanceId?: string;
        auth?: {
            token?: string;
            bootstrapToken?: string;
            deviceToken?: string;
            password?: string;
        };
        device?: {
            id: string;
            publicKey: string;
            signature: string;
            signedAt: number;
            nonce: string;
        };
        connection?: ConnectionConfig;
        requestTimeoutMs?: number;
        connectTimeoutMs?: number;
        autoReconnect?: boolean;
        maxReconnectAttempts?: number;
        reconnectDelayMs?: number;
    }
    Index

    Properties

    url clientId clientVersion? platform? deviceFamily? modelIdentifier? mode? instanceId? auth? device? connection? requestTimeoutMs? connectTimeoutMs? autoReconnect? maxReconnectAttempts? reconnectDelayMs?

    Properties

    url: string

    WebSocket URL to connect to

    clientId: string

    Client identifier

    clientVersion?: string

    Client version string

    platform?: string

    Platform identifier

    deviceFamily?: string

    Device family (optional)

    modelIdentifier?: string

    Model identifier (optional)

    mode?: string

    Client mode (default: "node")

    instanceId?: string

    Instance identifier (optional)

    auth?: {
        token?: string;
        bootstrapToken?: string;
        deviceToken?: string;
        password?: string;
    }

    Connection parameters for authentication

    Type Declaration

    • Optionaltoken?: string

      Authentication token

    • OptionalbootstrapToken?: string

      Bootstrap token

    • OptionaldeviceToken?: string

      Device token

    • Optionalpassword?: string

      Password

    device?: {
        id: string;
        publicKey: string;
        signature: string;
        signedAt: number;
        nonce: string;
    }

    Optional device pairing credentials

    connection?: ConnectionConfig

    Connection behavior configuration (nested form)

    requestTimeoutMs?: number

    Default request timeout in milliseconds (default: 30000)

    connectTimeoutMs?: number

    Connection timeout in milliseconds (default: 30000)

    autoReconnect?: boolean

    Whether to automatically reconnect on disconnect (default: true)

    maxReconnectAttempts?: number

    Maximum reconnection attempts (default: 10)

    reconnectDelayMs?: number

    Reconnection delay in milliseconds (default: 1000)

    Settings

    Member Visibility

    On This Page

    Properties