Connecting to Pinecone
Authentication
Pinecone uses API key authentication to control access to its API.
Using API Key Authentication
To authenticate using an API key, you must obtain your API key from your Pinecone console at https://app.pinecone.io/.
You can then connect by setting the AuthScheme to APIKey and providing your API key:
- AuthScheme: Set this to APIKey.
- APIKey: Set this to your API key from Pinecone.
Optionally, set the APIVersion property within the ProfileSettings property to specify which revision of the Pinecone API to use (for example, APIVersion=2025-10).
Example connection string
Profile=C:\profiles\Pinecone.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;APIVersion=2025-10';
Available Tables
The Pinecone API Profile provides the following tables:
- Indexes - Returns vector database indexes with their configuration, status, and host information.
- Models - Returns inference models available for embedding generation and document reranking, including provider details and supported parameters.
- Backups - Returns backup records, including backup status, size, and creation details.
- Collections - Returns static index snapshots with metadata and vector counts.
- Imports - Returns bulk import jobs that load datasets into indexes, including progress and status.
- Namespaces - Returns index namespace information, including vector counts and metadata.
- RestoreJobs - Returns backup restoration jobs, including progress and target index information.
- TextSearch - Returns search results for an index using text-based inputs that the inference service converts to vector queries.
- VectorSearch - Returns search results for an index using vector inputs (such as a vector ID or raw vector values) for similarity search.
- Vectors - Returns vector data and supports similarity search, filtering, and metadata access.
Usage Examples
Query a specific index:
SELECT * FROM Indexes WHERE Name = 'my-index'
Query embedding models only:
SELECT * FROM Models WHERE Type = 'embed'
Query backups for specific index:
SELECT * FROM Backups WHERE SourceIndexName = 'my-index'
Query import jobs with specific index host:
SELECT * FROM Imports WHERE IndexHost = 'https://my-index-host-url'
Query index namespaces:
SELECT * FROM Namespaces WHERE IndexHost = 'https://my-index-host-url'
Query completed restore jobs:
SELECT * FROM RestoreJobs WHERE RestoreJobId = '1234'
Query vector data with similarity search:
SELECT * FROM Vectors WHERE IndexHost = 'https://my-index-host-url'
Perform text-based search with inputs:
SELECT * FROM TextSearch WHERE IndexHost = 'https://my-index-host-url' AND NameSpace = 'name_space' AND Inputs = '{\"text\": \"machine learning\"}'
Perform vector search with inputs:
SELECT * FROM VectorSearch WHERE IndexHost = 'https://my-index-host-url' AND Id = '12345'
Connection Properties
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.
| Property | Description |
| APIKey | Specifies the API key used to authenticate to API. |
| APIVersion | Specifies the version of the API API to target. |
| AuthScheme | Specifies the authentication scheme used to connect to API. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT, OAUTH_PASSWORD |