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

    Type Alias PineconeConfiguration

    Understanding projects

    type PineconeConfiguration = {
        additionalHeaders?: HTTPHeaders;
        apiKey: string;
        assistantRegion?: string;
        caller?: { model: string; provider?: string };
        controllerHostUrl?: string;
        fetchApi?: FetchAPI;
        maxRetries?: number;
        sourceTag?: string;
    }
    Index
    additionalHeaders? apiKey assistantRegion? caller? controllerHostUrl? fetchApi? maxRetries? sourceTag?
    additionalHeaders?: HTTPHeaders

    Optional headers to be included in all requests.

    apiKey: string

    The API key for your Pinecone project. You can find this in the Pinecone console.

    assistantRegion?: string

    Optional configuration field for specifying a region to use with the assistant APIs. If not specified, the default region of "us" is used.

    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').

    const pc = new Pinecone({
      apiKey: 'your-api-key',
      caller: {
        provider: 'google',
        model: 'gemini'
      }
    });
    // User-Agent: ...; caller=google:gemini
    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.

    • 0: Makes only the initial request (no retries)
    • 1: Makes up to 2 attempts (1 initial + 1 retry)
    • 3 (default): Makes up to 4 attempts (1 initial + 3 retries)
    sourceTag?: string

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

    Settings
    Member Visibility

    On This Page
    Properties