Skip to main content

​
Introduction

LanceDB Cloud REST API allows you to interact with your remote table using standard HTTP requests.
LanceDB Quickstart will get you up and running in 5 minutes!
Our documentation site covers SDK examples in Python, Typescript and Rust.

​
Authentication

All HTTP requests to LanceDB APIs must contain an x-api-key header that specifies a valid API key and must be encoded as JSON or Arrow RPC.

​
Get the API Key

  1. Go to LanceDB Cloud and complete the onboarding.
create
  1. Let’s call this particular Project embedding.
  2. Save the API key and the project instance name: embedding-yhs6bg.
This is how the Project looks in the LanceDB Cloud Dashboard: projects
  1. In your terminal, check the existence of the remote Project. Specify the remote LanceDB Project db and region.
curl -X GET "https://{db}.{region}.api.lancedb.com/v1/tables" \
   -H "Content-Type: application/json" \
   -H "x-api-key: LANCEDB_API_KEY"
  1. Now, create a Table to store data. Let’s call it words.
curl -X POST "https://embedding-yhs6bg.us-east-1.api.lancedb.com/v1/tables/words" \
   -H "Content-Type: application/vnd.apache.arrow.stream" \
   -H "x-api-key: LANCEDB_API_KEY"
  • the db is embedding-yhs6bg
  • the region is us-east-1
  • the name of the table is words.
  1. Now check that the Table has been created:
curl -X GET "https://embedding-yhs6bg.us-east-1.api.lancedb.com/v1/tables" \
   -H "Content-Type: application/json" \
   -H "x-api-key: LANCEDB_API_KEY"
You can always check from the LanceDB Cloud Dashboard: words That’s it - you’re connected! Now, you can start adding data and querying it. The best way to start is to try the LanceDB Quickstart or read the documentation site.