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

    Interface CompanionAvatar

    The user's current companion avatar (see getAvatar).

    interface CompanionAvatar {
        archetype: "girlfriend" | "boyfriend" | "pet";
        imageUrl: string | null;
        modelId: string | null;
        name: string | null;
        vrmUrl: string | null;
    }
    Index
    archetype imageUrl modelId name vrmUrl
    archetype: "girlfriend" | "boyfriend" | "pet"

    Persona archetype driving the default look/voice.

    imageUrl: string | null

    Absolute URL to a flat 2D portrait when available; null for VRM-only built-ins today (reserved for custom previews / server-rendered thumbs).

    modelId: string | null

    The active model id (e.g. "default-gf-luna", or a custom id), or null.

    name: string | null

    Companion display name (the user's chosen name), or null.

    vrmUrl: string | null

    Absolute URL to the VRM 3D model — the avatar itself. CORS-enabled so a cross-origin renderer can fetch it. Null only if resolution failed.

    Settings
    Member Visibility

    On This Page
    Properties