Pinecone API API

by pinecone.io

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.

Pinecone API is a development API from pinecone.io. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 15 endpoints.

At a glance

Authentication: API key
HTTPS: Yes
CORS: Unknown
Category: Development
Version: 20230401.1
Endpoints: 15
OpenAPI: Specification ↗
Spec updated: 2023-04-02

Endpoints

Method	Path	What it does
GET	`/collections`	List collections
POST	`/collections`	Create collection
GET	`/collections/{collectionName}`	Describe collection
DELETE	`/collections/{collectionName}`	Delete Collection
POST	`/describe_index_stats`	Describe Index Stats
GET	`/indexes`	List indexes
POST	`/indexes`	Create index
GET	`/indexes/{indexName}`	Describe index
PATCH	`/indexes/{indexName}`	Configure index
DELETE	`/indexes/{indexName}`	Delete Index
POST	`/query`	Query
POST	`/vectors/delete`	Delete
POST	`/vectors/fetch`	Fetch
POST	`/vectors/update`	Fetch
POST	`/vectors/upsert`	Upsert