> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Pinecone

> How to set up the Pinecone connector, plus the actions that are available.

![Pinecone](https://stackone-logos.com/api/pinecone/filled/svg)

Betav0.2.1[See changelog](https://docs.stackone.com/connectors/pinecone/changelog.md)

[42 actions](#actions) · 1 auth method

IAM
Accounting
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/pinecone/guides/connector-profile/oauth-2-0.md)
>
> The Pinecone Admin API authenticates with a service account access token. A service account is created in the Pinecone c...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/pinecone/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

42 actions

ActionDescription

List API Keys`pinecone_list_project_api_keys`

Return the API keys that belong to a project, with the roles each key carries. Secret values are never returned.

Create An API Key`pinecone_create_api_key`

Issue a new API key for a project and return its secret value, which Pinecone shows only in this response.

Get API Key Details`pinecone_fetch_api_key`

Retrieve one API key by id, with its name, project and roles. The secret value is not returned.

Delete An API Key`pinecone_delete_api_key`

Permanently revoke an API key so it can no longer authenticate requests.

Update An API Key`pinecone_update_api_key`

Rename an API key or replace the set of roles it carries.

List Cost Usage Exports`pinecone_list_cost_usage_exports`

Return the organization's cost usage export jobs, newest first, optionally filtered by status. Download links are omitte...

Create A Cost Usage Export`pinecone_create_cost_usage_export`

Start an export of the organization's cost and usage data covering a range of UTC calendar days.

Get Cost Usage Export Details`pinecone_fetch_cost_usage_export`

Retrieve one cost usage export by id, including its status and, once complete, a time-limited download link.

Get Unified Credentials`pinecone_unified_get_me`

Get the current Pinecone connection's unified credentials and identity.

List Unified Organizations`pinecone_unified_list_organizations`

List the Pinecone organization the connection belongs to.

Get Unified Organization`pinecone_unified_get_organization`

Get a unified Pinecone organization by ID.

List Unified Roles`pinecone_unified_list_roles`

List the roles of a Pinecone organization.

Get Unified Role`pinecone_unified_get_role`

Get a Pinecone role by ID.

List Unified Users`pinecone_unified_list_users`

List unified users in a Pinecone organization.

Get Unified User`pinecone_unified_get_user`

Get a unified Pinecone user by ID.

List Invites`pinecone_list_invites`

Return the organization's invites with their status, expiry and processing time.

Invite A User To The Organization`pinecone_create_invite`

Invite a person to join the organization by email and set the roles they receive on acceptance.

Get Invite Details`pinecone_fetch_invite`

Retrieve one invite by id, with its status, expiry and the time it was processed.

Delete An Invite`pinecone_delete_invite`

Revoke a pending invite so the emailed link no longer grants access.

Resend An Invite Email`pinecone_resend_invite`

Send the invitation email again for a pending invite and extend how long it stays valid.

List Organizations`pinecone_list_organizations`

Return the organizations the calling service account can administer, with each plan and payment status.

Get Organization Details`pinecone_fetch_organization`

Retrieve one organization by id, including its plan, payment status and support tier.

Delete An Organization`pinecone_delete_organization`

Permanently delete an organization and every project inside it.

Update An Organization`pinecone_update_organization`

Change the display name of an organization. The plan, payment status and support tier are set by Pinecone and cannot be...

List Projects`pinecone_list_projects`

Return every project in the organization the service account belongs to, with each project's pod ceiling and CMEK settin...

Create A New Project`pinecone_create_project`

Create a project in the organization to hold indexes, API keys and project-scoped role bindings.

Get Project Details`pinecone_fetch_project`

Retrieve one project by id, including its pod ceiling, CMEK setting and owning organization.

Delete A Project`pinecone_delete_project`

Permanently delete a project together with the indexes and API keys it contains.

Update A Project`pinecone_update_project`

Rename a project or change its pod ceiling and CMEK enforcement.

List Role Bindings`pinecone_list_role_bindings`

Return the role bindings in the organization, filtered by principal, resource scope or role, to audit who holds which ac...

Create A Role Binding`pinecone_create_role_binding`

Grant a role to a user, service account, API key or invite at organization or project scope.

Get Role Binding Details`pinecone_fetch_role_binding`

Retrieve one role binding by id, showing the principal, the scope and the role it grants.

Delete A Role Binding`pinecone_delete_role_binding`

Revoke a role binding, removing the access it granted to its principal.

List Service Accounts`pinecone_list_service_accounts`

Return the organization's service accounts with their OAuth client IDs. Client secrets are never returned.

Create A Service Account`pinecone_create_service_account`

Create a service account for machine-to-machine access and return its OAuth client secret, shown only in this response.

Get Service Account Details`pinecone_fetch_service_account`

Retrieve one service account by id, with its name, OAuth client ID and timestamps.

Delete A Service Account`pinecone_delete_service_account`

Permanently delete a service account so its client credentials stop working.

Update A Service Account`pinecone_update_service_account`

Change the display name of a service account. Its OAuth client ID and role bindings are unaffected.

Rotate A Service Account's OAuth Client Secret`pinecone_rotate_service_account_secret`

Issue a new OAuth client secret for a service account and invalidate the previous one immediately.

List Users In The Organization`pinecone_list_users`

Return the users who are members of the organization, optionally filtered by email address.

Get User Details`pinecone_fetch_user`

Retrieve one organization member by id, with their name and email address.

Remove A User From The Organization`pinecone_delete_user`

Remove a user from the organization, revoking the access their role bindings granted.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.