Langfuse JS/TS SDKs
    Preparing search index...

    Interface LangfuseClientParams

    Configuration parameters for initializing a LangfuseClient instance.

    interface LangfuseClientParams {
        additionalHeaders?: Record<string, string>;
        baseUrl?: string;
        publicKey?: string;
        secretKey?: string;
        timeout?: number;
    }
    Index

    Properties

    additionalHeaders? baseUrl? publicKey? secretKey? timeout?

    Properties

    additionalHeaders?: Record<string, string>

    Additional HTTP headers to include with API requests.

    baseUrl?: string

    Base URL of the Langfuse instance to connect to, e.g. https://cloud.langfuse.com (EU), https://us.cloud.langfuse.com (US), https://jp.cloud.langfuse.com (Japan), https://hipaa.cloud.langfuse.com (HIPAA), or your self-hosted URL, https://jp.cloud.langfuse.com (Japan), https://hipaa.cloud.langfuse.com (HIPAA).

    "https://cloud.langfuse.com"
    publicKey?: string

    Public API key for authentication with Langfuse. Can also be provided via LANGFUSE_PUBLIC_KEY environment variable.

    secretKey?: string

    Secret API key for authentication with Langfuse. Can also be provided via LANGFUSE_SECRET_KEY environment variable.

    timeout?: number

    Request timeout in seconds for each HTTP request made by the SDK managers: score ingestion (langfuse.score), prompt management (langfuse.prompt, unless fetchTimeoutMs is passed to get) and media resolution (langfuse.media). Retried requests get the timeout per attempt. Can also be provided via LANGFUSE_TIMEOUT environment variable.

    Direct langfuse.api.* calls do not use this value; pass { timeoutInSeconds } as request options per call instead.

    5

    Settings

    Member Visibility

    On This Page

    Properties