Users are recommended to follow Quickstart to use official Python and Typescript SDKs, for better developer experience.

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 an API Key

  • Create a new project on the dashboard, or use the Default project.
  • Go to the API KEYS tab to generate an API key.

then

curl -X GET "https://{db}.{region}.api.lancedb.com/v1/table/" \
   -H "Content-Type: application/json" \
   -H "x-api-key: LANCEDB_API_KEY"

or

curl -X GET "https://{db}.{region}.api.lancedb.com/v1/table/test-table1/create/" \
   -H "Content-Type: application/vnd.apache.arrow.stream" \
   -H "x-api-key: LANCEDB_API_KEY"