Type Alias PineconeConfiguration

Type declaration

• OptionaladditionalHeaders?: 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.

• OptionalassistantRegion?: string

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

• Optionalcaller?: { 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).

  Example

  const pc = new Pinecone({
    apiKey: 'your-api-key',
    caller: {
      provider: 'google',
      model: 'gemini'
    }
  });
  // User-Agent: ...; caller=google:gemini
  Copy

  • model: string

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

  • Optionalprovider?: string

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

• OptionalcontrollerHostUrl?: string

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

• OptionalfetchApi?: FetchAPI

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

• OptionalmaxRetries?: 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)

• OptionalsourceTag?: string

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