Account Request URL
-Base Endpoint
-
Search
Retrieve a list of documents that are similar to the provided query vector.
/search
dataset_id, top_k, include_metadata, include_scores, vector
Index
Add a list of documents to the index. Each document is represented as a vector.
/indexes/{index_name}/documents
index_name, documents
Document
Upload a single document to the index.
/indexes/{index_name}/documents/batch
index_name, documents
Datasets
Retrieve a list of all the datasets in the project.
/datasets
project_id, page_size, page_token
Delete Index
Delete an existing index.
/indexes/{index_name}
index_name
Delete Dataset
Delete an existing dataset.
/datasets/{dataset_id}
dataset_id
Vectors Get
Retrieve vectors of a list of documents.
/indexes/{index_name}/vectors/multiGet
index_name, ids
Index Get
Retrieve information about an existing index.
/indexes/{index_name}
index_name
Dataset Get
Retrieve information about an existing dataset.
/datasets/{dataset_id}
dataset_id
Pages Delete
Delete a page of documents from an index.
/indexes/{index_name}/pages/{page_id}
index_name, page_id
Page
Upload a page of documents to the index.
/indexes/{index_name}/pages/batch
index_name, documents
Query By Embeddings
Retrieve a list of documents that are similar to the provided query embeddings. Optionally compute pairwise distances.
/indexes/{index_name}/queries/embeddings
index_name, embeddings, top_k, include_metadata, include_scores, distance, skip
Vectors Multi Delete
Delete a list of vectors from the index.
/indexes/{index_name}/vectors/batchDelete
index_name, ids
Pages Get
Retrieve a single page of documents from the index.
/indexes/{index_name}/pages/{page_id}
index_name, page_id
Query
Retrieves a list of documents that are similar to the provided query vector.
/indexes/{index_name}/queries
index_name, vector, top_k, include_metadata, include_scores
Provider
Country HQ
API Type
Categories
Alternatives
Important URLs
Last Updated on
Created At
Upskill for a better future
Want to start tracking API at scale?
Get updates about your favorite APIs and SDKs
We do our best to ensure that the data we release is complete, accurate, and useful. However, because we are not able to verify all the data, and because the processing required to make the data useful is complex, we cannot be held liable for omissions or inaccuracies.