To reduce friction for users using your integration, you can create a custom object, like a button or link, to trigger a Connect to Pinecone popup from your app, website, or Colab notebook. Within this popup, your users can sign up for or log in to Pinecone, select or create an organization and project to connect to, and generate an API key. The API key is then communicated back to the user to copy or directly sent to the hosting page, app, or notebook.
Alternatively, you can embed our pre-built widget, which provides the same functionality, but with the ease of a drop-in component.
To start, create an integration ID for your app.
Only organization owners can add or manage integrations.
Create a unique integrationId
to enable usage of the Connect to Pinecone popup and widget:
On the the Integrations tab in the Pinecone console, click the Create Integration button.
Fill out the Create integration form:
Integration name: Give your integration a name.
URL Slug: This is your integrationID
. Enter a human-readable string that uniquely identifies your integration and that may appear in URLs. Your integration URL slug is public and cannot be changed.
Logo: Upload a logo for your integration.
Return mechanism: Select one of the following return methods for the generated API key:
Allowed origin: If you selected Web Message as your Return mechanism, list the URL origin(s) where your integration is hosted. The origin is the part of the URL that specifies the protocol, hostname, and port.
Click Create.
Anyone can create an integration, but becoming an official Pinecone partner can help accelerate your go-to-market and add value to your customers.
Once you have created your integrationId
, you can create a custom object, like a button or link, that loads a Connect to Pinecone popup that displays as follows:
The ConnectPopup
function can be called with either the JavaScript library or script. The JavaScript library is the most commonly used method, but the script can be used in instances where you cannot build and use a custom library, like within the constraints of a content management system (CMS).
The function includes the following required configuration option:
integrationId
: The slug assigned to the integration. If integrationId
is not passed, the widget will not render.
integrationId
, fill out the Create Integration form.The function returns an object containing the following:
open
: A function that opens the popup. Suitable for use as an on-click handler.Example usage of the library and script:
Once you have created your integration, be sure to attribute usage to your integration.
The pre-built Connect widget displays as follows:
Once you have created your integrationId
, you can embed the Connect widget multiple ways:
@pinecone-database/connect
) or script: Renders the widget in apps and websites.pinecone-notebooks
): Renders the widget in Colab notebooks using Python.Once you have created your integration, be sure to attribute usage to your integration.
To embed the Connect to Pinecone widget in your app or website using the @pinecone-database/connect
library, install the necessary dependencies:
You can use the JavaScript library to render the Connect to Pinecone widget and obtain the API key with the connectToPinecone
function. It displays the widget and calls the provided callback function with the Pinecone API key, once the user completes the flow.
The function includes the following required configuration options:
integrationId
: The slug assigned to the integration. If integrationId
is not passed, the widget will not render.
integrationId
, fill out the Create Integration form with Pinecone.container
: The HTML element where the Connect widget will render.
Example usage:
If you cannot use the JavaScript library, you can directly call the script. For example:
To embed the Connect widget in your Colab notebook, use the pinecone-notebooks
Python library:
To see this flow in practice, see our example notebook.
Your users can manage the API keys generated by your integration in the Pinecone console.
To reduce friction for users using your integration, you can create a custom object, like a button or link, to trigger a Connect to Pinecone popup from your app, website, or Colab notebook. Within this popup, your users can sign up for or log in to Pinecone, select or create an organization and project to connect to, and generate an API key. The API key is then communicated back to the user to copy or directly sent to the hosting page, app, or notebook.
Alternatively, you can embed our pre-built widget, which provides the same functionality, but with the ease of a drop-in component.
To start, create an integration ID for your app.
Only organization owners can add or manage integrations.
Create a unique integrationId
to enable usage of the Connect to Pinecone popup and widget:
On the the Integrations tab in the Pinecone console, click the Create Integration button.
Fill out the Create integration form:
Integration name: Give your integration a name.
URL Slug: This is your integrationID
. Enter a human-readable string that uniquely identifies your integration and that may appear in URLs. Your integration URL slug is public and cannot be changed.
Logo: Upload a logo for your integration.
Return mechanism: Select one of the following return methods for the generated API key:
Allowed origin: If you selected Web Message as your Return mechanism, list the URL origin(s) where your integration is hosted. The origin is the part of the URL that specifies the protocol, hostname, and port.
Click Create.
Anyone can create an integration, but becoming an official Pinecone partner can help accelerate your go-to-market and add value to your customers.
Once you have created your integrationId
, you can create a custom object, like a button or link, that loads a Connect to Pinecone popup that displays as follows:
The ConnectPopup
function can be called with either the JavaScript library or script. The JavaScript library is the most commonly used method, but the script can be used in instances where you cannot build and use a custom library, like within the constraints of a content management system (CMS).
The function includes the following required configuration option:
integrationId
: The slug assigned to the integration. If integrationId
is not passed, the widget will not render.
integrationId
, fill out the Create Integration form.The function returns an object containing the following:
open
: A function that opens the popup. Suitable for use as an on-click handler.Example usage of the library and script:
Once you have created your integration, be sure to attribute usage to your integration.
The pre-built Connect widget displays as follows:
Once you have created your integrationId
, you can embed the Connect widget multiple ways:
@pinecone-database/connect
) or script: Renders the widget in apps and websites.pinecone-notebooks
): Renders the widget in Colab notebooks using Python.Once you have created your integration, be sure to attribute usage to your integration.
To embed the Connect to Pinecone widget in your app or website using the @pinecone-database/connect
library, install the necessary dependencies:
You can use the JavaScript library to render the Connect to Pinecone widget and obtain the API key with the connectToPinecone
function. It displays the widget and calls the provided callback function with the Pinecone API key, once the user completes the flow.
The function includes the following required configuration options:
integrationId
: The slug assigned to the integration. If integrationId
is not passed, the widget will not render.
integrationId
, fill out the Create Integration form with Pinecone.container
: The HTML element where the Connect widget will render.
Example usage:
If you cannot use the JavaScript library, you can directly call the script. For example:
To embed the Connect widget in your Colab notebook, use the pinecone-notebooks
Python library:
To see this flow in practice, see our example notebook.
Your users can manage the API keys generated by your integration in the Pinecone console.