Skip to main content
Pinecone
Betav0.1.0
35 actions · 1 auth method

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · OAuth 2.0

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 (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · OAuth 2.0

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

35 actions
Action
Description
List 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
Issue a new API key for a project and return its secret value, which Pinecone shows only in this response.
Get API Key Details
Retrieve one API key by id, with its name, project and roles. The secret value is not returned.
Delete An API Key
Permanently revoke an API key so it can no longer authenticate requests.
Update An API Key
Rename an API key or replace the set of roles it carries.
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
Start an export of the organization’s cost and usage data covering a range of UTC calendar days.
Get Cost Usage Export Details
Retrieve one cost usage export by id, including its status and, once complete, a time-limited download link.
List Invites
Return the organization’s invites with their status, expiry and processing time.
Invite A User To The Organization
Invite a person to join the organization by email and set the roles they receive on acceptance.
Get Invite Details
Retrieve one invite by id, with its status, expiry and the time it was processed.
Delete An Invite
Revoke a pending invite so the emailed link no longer grants access.
Resend An Invite Email
Send the invitation email again for a pending invite and extend how long it stays valid.
List Organizations
Return the organizations the calling service account can administer, with each plan and payment status.
Get Organization Details
Retrieve one organization by id, including its plan, payment status and support tier.
Delete An Organization
Permanently delete an organization and every project inside it.
Update An Organization
Change the display name of an organization. The plan, payment status and support tier are set by Pinecone and cannot be…
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
Create a project in the organization to hold indexes, API keys and project-scoped role bindings.
Get Project Details
Retrieve one project by id, including its pod ceiling, CMEK setting and owning organization.
Delete A Project
Permanently delete a project together with the indexes and API keys it contains.
Update A Project
Rename a project or change its pod ceiling and CMEK enforcement.
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
Grant a role to a user, service account, API key or invite at organization or project scope.
Get Role Binding Details
Retrieve one role binding by id, showing the principal, the scope and the role it grants.
Delete A Role Binding
Revoke a role binding, removing the access it granted to its principal.
List Service Accounts
Return the organization’s service accounts with their OAuth client IDs. Client secrets are never returned.
Create A 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
Retrieve one service account by id, with its name, OAuth client ID and timestamps.
Delete A Service Account
Permanently delete a service account so its client credentials stop working.
Update A 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
Issue a new OAuth client secret for a service account and invalidate the previous one immediately.
List Users In The Organization
Return the users who are members of the organization, optionally filtered by email address.
Get User Details
Retrieve one organization member by id, with their name and email address.
Remove A User From The Organization
Remove a user from the organization, revoking the access their role bindings granted.