How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

LanceDB Data API

Operations that interact with object data and might be computationally intensive

LanceDB Data API is one of 16 APIs that LanceDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Data. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and release notes.

This API exposes 13 operations across 13 paths, and defines 35 schemas. It is described by OpenAPI 3.1.1, at version 1.0.0.

Requests are made against 2 base URLs: {scheme}://{host}:{port}/{basePath}, {scheme}://{host}/{basePath}.

13 operations 13 paths 35 schemas 13 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.1
API Version
1.0.0
Base URL
https://github.com/lancedb/lancedb
Authentication
OAuth 2.0, HTTP Bearer, API Key
License
Resource Areas
1

Authentication & Security 3

LanceDB Data API declares 3 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the clientCredentials flow. It accepts HTTP bearer tokens (BearerAuth). An API key is passed in the header as x-api-key (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 13

Across 13 paths, the API surfaces 13 operations — 13 POST. Each is listed below with its method, path, parameters, and response codes.

Data 13

Operations that interact with object data and might be computationally intensive

POST
/v1/table/{id}/insert
Insert records into a table
InsertIntoTable 3 params body → 2004004014034045035XX
POST
/v1/table/{id}/merge_insert
Merge insert (upsert) records into a table
MergeInsertIntoTable 10 params body → 2004004014034045035XX
POST
/v1/table/{id}/update
Update rows in a table
UpdateTable 2 params body → 2004004014034045035XX
POST
/v1/table/{id}/delete
Delete rows from a table
DeleteFromTable 2 params body → 2004004014034045035XX
POST
/v1/table/{id}/query
Query a table
QueryTable 2 params body → 2004004014034045035XX
POST
/v1/table/{id}/count_rows
Count rows in a table
CountTableRows 2 params body → 2004004014034045035XX
POST
/v1/table/{id}/create
Create a table with the given name
CreateTable 5 params body → 2004004014034044095035XX
POST
/v1/table/{id}/explain_plan
Get query execution plan explanation
ExplainTableQueryPlan 2 params body → 2004004014034045035XX
POST
/v1/table/{id}/analyze_plan
Analyze query execution plan
AnalyzeTableQueryPlan 2 params body → 2004004014034045035XX
POST
/v1/table/{id}/add_columns
Add new columns to table schema
AlterTableAddColumns 2 params body → 2004004014034045035XX
POST
/v1/table/{id}/backfill_column
Trigger an async column backfill job
AlterTableBackfillColumns 2 params body → 2024004014034045035XX
POST
/v1/materialized_view/{id}/refresh
Trigger an async materialized view refresh
RefreshMaterializedView 2 params body → 2024004014034045035XX
POST
/v1/materialized_view/{id}/create
Create a materialized view
CreateMaterializedView 2 params body → 2014004014034044095035XX

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are AnalyzeTableQueryPlanRequest (21 properties), QueryTableRequest (21 properties), AlterTableBackfillColumnsRequest (16 properties), MaterializedViewUdtfEntry (15 properties). Each schema is shown below with its type and property counts.

PhraseQuery
object
3 properties 1 required
CreateTableResponse
object
5 properties
CountTableRowsResponse
integer
Response containing the count of rows. Serializes transparently as just the number for backward compatibility.
ExplainTableQueryPlanRequest
object
5 properties 1 required
MaterializedViewUdtfEntry
object
15 properties 5 required
AlterTableAddColumnsRequest
object
3 properties 1 required
BoostQuery
object
Boost query that scores documents matching positive query higher and negative query lower
3 properties 2 required
DeleteFromTableResponse
object
2 properties
AddColumnsEntry
object
3 properties 1 required
FtsQuery
object
Full-text search query. Exactly one query type field must be provided. This structure follows the same pattern as AlterTransactionAction to minimize difference…
5 properties
AddVirtualColumnEntry
object
11 properties 6 required
QueryTableRequest
object
21 properties 2 required
AlterTableBackfillColumnsRequest
object
16 properties 1 required
UpdateTableResponse
object
4 properties 2 required
RefreshMaterializedViewRequest
object
9 properties
Identity
object
Identity information of a request.
2 properties
CreateMaterializedViewRequest
object
8 properties 3 required
DeleteFromTableRequest
object
Delete data from table based on a SQL predicate. Returns the number of rows that were deleted.
4 properties 1 required
RefreshMaterializedViewResponse
object
1 property 1 required
AlterTableBackfillColumnsResponse
object
1 property 1 required
CountTableRowsRequest
object
5 properties
CreateMaterializedViewResponse
object
2 properties 1 required
ErrorResponse
object
Common JSON error response model
4 properties 1 required
UpdateTableRequest
object
Each update consists of a column name and an SQL expression that will be evaluated against the current row's value. Optionally, a predicate can be provided to…
6 properties 1 required
Operator
string
The operator to use for combining terms. Case insensitive, supports both PascalCase and snakecase. Valid values are: - And: All terms must match. - Or: At leas…
AnalyzeTableQueryPlanRequest
object
21 properties 2 required
MultiMatchQuery
object
1 property 1 required
StringFtsQuery
object
2 properties 1 required
InsertIntoTableResponse
object
Response from inserting records into a table
1 property
Context
object
Arbitrary context for a request as key-value pairs. How to use the context is custom to the specific implementation. REST NAMESPACE ONLY Context entries are pa…
AlterTableAddColumnsResponse
object
1 property 1 required
StructuredFtsQuery
object
1 property 1 required
BooleanQuery
object
Boolean query with must, should, and mustnot clauses
3 properties 3 required
MergeInsertIntoTableResponse
object
Response from merge insert operation
5 properties
MatchQuery
object
7 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lancedb-data-api-openapi.yml Raw ↑

Other APIs LanceDB publishes across the network.

LanceDB Enterprise
Lance Format
LanceDB Python SDK
LanceDB TypeScript SDK
LanceDB Rust SDK
LanceDB Go SDK
LanceDB C Bindings
LanceDB MCP Server
LanceDB Index API
LanceDB MaterializedView API
LanceDB Metadata API
LanceDB Namespace API
Where this information came from

This is an independent, third-party profile of LanceDB Data API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.