Skip to content

Search is only available in production builds. Try building and previewing the site to test it out locally.

LanceDB Cloud API

LanceDB Cloud API is a RESTful API that allows users to access and modify data stored in LanceDB Cloud. Table actions are considered temporary resource creations and all use POST method.

Authentication

Bearer {token}

Base URL

https://api.lancedb.io

Rate limits

Not specified.

Endpoints

MethodPathDescription
GET/v1/table/Lists all tables in the LanceDB instance, with optional pagination support.
POST/v1/table/{name}/create/Creates a new table with the specified name in the LanceDB instance.
POST/v1/table/{name}/query/Performs a vector similarity search on a named LanceDB table, returning the nearest neighbors to a given query vector.
POST/v1/table/{name}/insert/Insert new rows of data into a specified LanceDB table.
POST/v1/table/{name}/merge_insert/Performs a merge insert (upsert) operation on a named table, allowing rows to be added, updated, and removed in a single atomic transaction.
POST/v1/table/{name}/delete/Deletes one or more rows from a specified table using a filter predicate.
POST/v1/table/{name}/drop/Permanently deletes a specified table and all of its data from the LanceDB instance.
POST/v1/table/{name}/describe/Describes a LanceDB table and returns its metadata and schema information.
POST/v1/table/{name}/index/list/Lists all indexes defined on a specified LanceDB table.
POST/v1/table/{name}/create_index/Creates a vector index on a specified LanceDB table to enable fast approximate nearest neighbor (ANN) search.
POST/v1/table/{name}/create_scalar_index/Creates a scalar index on a specified column of a LanceDB table to accelerate scalar filtering queries.
POST/v1/table/{name}/index/{index_name}/drop/Drops a named index from a specified table in LanceDB.

Error format

Standard HTTP status codes with JSON error body.