LanceDB

LanceDB REST API

The LanceDB REST API is a RESTful API that allows users to access and modify data stored in LanceDB Enterprise or LanceDB Cloud (legacy). Table actions are…

Data & analytics#openapi

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

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

Endpoints 12

Tables

  • GETList Tables/v1/table/List tables, optionally, with pagination.
  • POSTCreate a new table/v1/table/:name/create/Create a new table
  • POSTDrop a table/v1/table/:name/drop/Drop a table
  • POSTDescribe a table/v1/table/:name/describe/Describe a table and return Table Information.
  • POSTList indexes of a table/v1/table/:name/index/list/List indexes of a table
  • POSTCreate vector index on a Table/v1/table/:name/create_index/Create vector index on a Table
  • POSTCreate a scalar index on a table/v1/table/:name/create_scalar_index/Create a scalar index on a table
  • POSTDrop an index from the table/v1/table/:name/index/:index_name/drop/Drop an index from the table

Data

  • POSTVector Query/v1/table/:name/query/Vector Query
  • POSTInsert new data./v1/table/:name/insert/Insert new data to the Table.
  • POSTMerge Insert/v1/table/:name/merge_insert/?on=stringCreate a "merge insert" operation This operation can add rows, update rows, and remove rows all in a single transaction. See python method…
  • POSTDelete rows from a table/v1/table/:name/delete/Delete rows from a table.

API details

Base URL
https://{db}.{region}.api.lancedb.com
Authentication
An API key in the x-api-key header
Operations
12 operations on 12 pathsPOST 11GET 1
Main resources
Tables 8Data 4
Response formats
application/json
Description format
OpenAPI 3.1.0, API version 1.0.0

How to test the LanceDB REST 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 LanceDB REST API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the x-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 Tables” (GET /v1/table/), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the LanceDB REST API?

The LanceDB REST API is a RESTful API that allows users to access and modify data stored in LanceDB Enterprise or LanceDB Cloud (legacy). Table actions are… It is listed under Data & analytics and has 12 endpoints.

Who publishes the LanceDB REST API?

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

What is the base URL of the LanceDB REST API?

Requests go to https://{db}.{region}.api.lancedb.com. Endpoint paths are added to this base URL.

How do I authenticate with the LanceDB REST API?

With an API key in the x-api-key header.

How many endpoints does the LanceDB REST API have?

12 operations on 12 paths (11 POST, 1 GET). The largest groups are Tables, Data.

Is forking the LanceDB REST 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.