Pinecone TypeScript SDK - v8.2.0
    Preparing search index...

    Type Alias AdminClientConfiguration

    Configuration for the AdminClient.

    The Admin API authenticates with a Pinecone service account using the OAuth2 client-credentials flow, which is distinct from the apiKey used by the Pinecone client. You must supply a clientId and clientSecret (either directly or via the PINECONE_CLIENT_ID / PINECONE_CLIENT_SECRET environment variables). Create a service account and its credentials in the Pinecone console under Organization Settings → Service Accounts.

    type AdminClientConfiguration = {
        additionalHeaders?: HTTPHeaders;
        caller?: { model: string; provider?: string };
        clientId?: string;
        clientSecret?: string;
        controllerHostUrl?: string;
        fetchApi?: FetchAPI;
        maxRetries?: number;
        sourceTag?: string;
    }
    Index
    additionalHeaders? caller? clientId? clientSecret? controllerHostUrl? fetchApi? maxRetries? sourceTag?
    additionalHeaders?: HTTPHeaders

    Optional headers to be included in all requests.

    caller?: { model: string; provider?: string }

    Optional caller information that is applied to the User-Agent header with all requests. Used to identify agentic callers using the SDK (e.g., AI coding assistants).

    Type Declaration

    • model: string

      Required model name (e.g., 'gemini', 'claude-code', 'gpt-4').

    • Optionalprovider?: string

      Optional provider identifier (e.g., 'google', 'anthropic', 'openai').

    clientId?: string

    The service account OAuth2 client ID. Falls back to the PINECONE_CLIENT_ID environment variable when not provided.

    clientSecret?: string

    The service account OAuth2 client secret. Falls back to the PINECONE_CLIENT_SECRET environment variable when not provided.

    controllerHostUrl?: string

    Optional configuration field for specifying the controller host. If not specified, the client will use the default controller host: https://api.pinecone.io.

    fetchApi?: FetchAPI

    Optional configuration field for specifying the fetch implementation. If not specified, the client will look for fetch in the global scope.

    maxRetries?: number

    Optional configuration field for specifying the maximum number of retries after the initial request. Defaults to 3.

    sourceTag?: string

    Optional sourceTag that is applied to the User-Agent header with all requests.

    Settings
    Member Visibility

    On This Page
    Properties