Pinecone API

OpenAPI apis-guru backend

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.

Homepage: https://api.apis.guru/v2/specs/pinecone.io/20230401.1.json
Provider: pinecone.io
OpenAPI version: 3.0.2
Spec (JSON): https://api.apis.guru/v2/specs/pinecone.io/20230401.1/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/pinecone.io/20230401.1/openapi.yaml

Tools (17)

Extracted live via the executor SDK.

indexOperations.configureIndex

This operation specifies the pod type and number of replicas for an index.
indexOperations.createCollection

This operation creates a Pinecone collection.
indexOperations.createIndex

This 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 of replicas to use, and more.
indexOperations.deleteCollection

This operation deletes an existing collection.
indexOperations.deleteIndex

This operation deletes an existing index.
indexOperations.describeCollection

Get a description of a collection.
indexOperations.describeIndex

Get a description of an index.
indexOperations.listCollections

This operation returns a list of your Pinecone collections.
indexOperations.listIndexes

This operation returns a list of your Pinecone indexes.
vectorOperations.delete

The Delete operation deletes vectors, by id, from a single namespace. You can delete items by their id, from a single namespace.
vectorOperations.describeIndexStats

The DescribeIndexStats operation returns statistics about the index's contents, including the vector count per namespace and the number of dimensions.
vectorOperations.fetch

The Fetch operation looks up and returns vectors, by ID, from a single namespace. The returned vectors include the vector data and/or metadata.
vectorOperations.query

The 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 scores.
vectorOperations.update

The 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 the fields specified in it will be added or overwrite the previous value.
vectorOperations.upsert

The Upsert operation writes vectors into a namespace. If a new value is upserted for an existing vector id, it will overwrite the previous value.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools