Sanity Library Reference Docs
    Preparing search index...

    Interface SanityConfig

    Represents the complete configuration for a Sanity SDK instance

    interface SanityConfig {
        auth?: AuthConfig;
        dataset?: string;
        perspective?: ReleasePerspective | ClientPerspective;
        projectId?: string;
        source?: DocumentSource;
        sources?: Record<string, DocumentSource>;
        studio?: StudioConfig;
        studioMode?: { enabled: boolean };
    }

    Hierarchy (View Summary)

    Index

    Properties

    auth? dataset? perspective? projectId? source? sources? studio? studioMode?

    Properties

    auth?: AuthConfig

    Authentication configuration for the instance

    Merged with parent configurations when using createChild

    dataset?: string
    perspective?: ReleasePerspective | ClientPerspective
    projectId?: string
    source?: DocumentSource

    Explicit source object to use for this operation.

    sources?: Record<string, DocumentSource>

    A list of named sources to use for this instance.

    studio?: StudioConfig

    Studio configuration provided by a Sanity Studio workspace. When present, the SDK operates in studio mode and derives auth from the workspace's reactive token source — no manual configuration needed.

    Typically set automatically by SanityApp when it detects an SDKStudioContext provider. Can also be set explicitly for programmatic use.

    studioMode?: { enabled: boolean }

    Studio mode configuration for use of the SDK in a Sanity Studio.

    Controls whether studio mode features are enabled.

    Use studio instead, which provides richer integration with the Studio's workspace (auth token sync, etc.).

    Settings

    Member Visibility

    On This Page

    Properties