Pinecone

Pinecone API

Pinecone is a vector database. This is an unofficial, community-managed OpenAPI spec that (should) accurately model the Pinecone API. This project was…

Developer tools#openapi#backend

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Pinecone is a vector database. This is an unofficial, community-managed OpenAPI spec that (should) accurately model the Pinecone API. This project was developed independent of and is unaffiliated with Pinecone Systems. Users should switch to the official API spec, if and when Pinecone releases it.

Endpoints 15

Index Operations

  • GETList collections/collectionsThis operation returns a list of your Pinecone collections.
  • POSTCreate collection/collectionsThis operation creates a Pinecone collection.
  • GETDescribe collection/collections/:collectionNameGet a description of a collection.
  • DELETEDelete Collection/collections/:collectionNameThis operation deletes an existing collection.
  • GETList indexes/indexesThis operation returns a list of your Pinecone indexes.
  • POSTCreate index/indexesThis operation creates a Pinecone index. You can use it to specify the measure of similarity, the dimension of vectors to be stored in the index, the numbers…
  • GETDescribe index/indexes/:indexNameGet a description of an index.
  • DELETEDelete Index/indexes/:indexNameThis operation deletes an existing index.
  • PATCHConfigure index/indexes/:indexNameThis operation specifies the pod type and number of replicas for an index.

Vector Operations

  • POSTDescribe Index Statshttps://example-abcd1234.svc.us-east1-gcp.pincone.io/describe_index_statsThe DescribeIndexStats operation returns statistics about the index's contents, including the vector count per namespace and the number of dimensions.
  • POSTQueryhttps://example-abcd1234.svc.us-east1-gcp.pincone.io/queryThe Query operation searches a namespace, using a query vector. It retrieves the ids of the most similar items in a namespace, along with their similarity…
  • POSTDeletehttps://example-abcd1234.svc.us-east1-gcp.pincone.io/vectors/deleteThe Delete operation deletes vectors, by id, from a single namespace. You can delete items by their id, from a single namespace.
  • POSTFetchhttps://example-abcd1234.svc.us-east1-gcp.pincone.io/vectors/fetchThe Fetch operation looks up and returns vectors, by ID, from a single namespace. The returned vectors include the vector data and/or metadata.
  • POSTFetchhttps://example-abcd1234.svc.us-east1-gcp.pincone.io/vectors/updateThe Update operation updates vector in a namespace. If a value is included, it will overwrite the previous value. If a set_metadata is included, the values of…
  • POSTUpserthttps://example-abcd1234.svc.us-east1-gcp.pincone.io/vectors/upsertThe Upsert operation writes vectors into a namespace. If a new value is upserted for an existing vector id, it will overwrite the previous value.

API details

Base URL
https://controller.{environment}.pinecone.io
Authentication
An API key in the Api-Key header
Operations
15 operations on 10 pathsPOST 8GET 4DELETE 2PATCH 1
Main resources
Index Operations 9Vector Operations 6
Response formats
application/json text/plain
Description format
OpenAPI 3.0.2, API version 20230401.1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Pinecone API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Pinecone API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Api-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List collections” (GET /collections), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Pinecone API?

Pinecone is a vector database. This is an unofficial, community-managed OpenAPI spec that (should) accurately model the Pinecone API. This project was… It is listed under Developer tools and has 15 endpoints.

Who publishes the Pinecone API?

It is listed from Pinecone's public API description (an OpenAPI document), not published by Pinecone on Swastik Codes. Anyone who controls pinecone.io can claim the profile by adding a DNS TXT record.

What is the base URL of the Pinecone API?

Requests go to https://controller.{environment}.pinecone.io. Endpoint paths are added to this base URL.

How do I authenticate with the Pinecone API?

With an API key in the Api-Key header.

How many endpoints does the Pinecone API have?

15 operations on 10 paths (8 POST, 4 GET, 2 DELETE, 1 PATCH). The largest groups are Index Operations, Vector Operations.

Is forking the Pinecone API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.