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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
LanceDB

LanceDB Metadata API

Operations that only interact with object metadata and should be computationally lightweight

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 36 operations across 36 paths, and defines 89 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}.

36 operations 36 paths 89 schemas 2 GET34 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
Apache 2.0
Resource Areas
1

Authentication & Security 3

LanceDB Metadata 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 36

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

Metadata 36

Operations that only interact with object metadata and should be computationally lightweight

POST
/v1/namespace/{id}/create
Create a new namespace
CreateNamespace 2 params body → 200400401403404406409503
GET
/v1/namespace/{id}/list
List namespaces
ListNamespaces 4 params → 2004004014034044065035XX
POST
/v1/namespace/{id}/describe
Describe a namespace
DescribeNamespace 2 params body → 2004004014034045035XX
POST
/v1/namespace/{id}/drop
Drop a namespace
DropNamespace 2 params body → 2004004014034044095035XX
POST
/v1/namespace/{id}/exists
Check if a namespace exists
NamespaceExists 2 params body → 2004004014034045035XX
GET
/v1/namespace/{id}/table/list
List tables in a namespace
ListTables 5 params → 2004004014034044065035XX
POST
/v1/table/{id}/register
Register a table to a namespace
RegisterTable 2 params body → 200400401403404406409503
POST
/v1/table/{id}/describe
Describe information of a table
DescribeTable 5 params body → 2004004014034045035XX
POST
/v1/table/{id}/exists
Check if a table exists
TableExists 2 params body → 2004004014034045035XX
POST
/v1/table/{id}/drop
Drop a table
DropTable 2 params → 2004004014034045035XX
POST
/v1/table/{id}/deregister
Deregister a table
DeregisterTable 2 params body → 2004004014034045035XX
POST
/v1/table/{id}/restore
Restore table to a specific version
RestoreTable 2 params body → 2004004014034045035XX
POST
/v1/table/{id}/rename
Rename a table
RenameTable 2 params body → 2004004014034044095035XX
POST
/v1/table/{id}/schema_metadata/update
Update table schema metadata
UpdateTableSchemaMetadata 2 params body → 2004004014034045035XX
POST
/v1/table/{id}/version/list
List all versions of a table
ListTableVersions 5 params → 2004004014034045035XX
POST
/v1/table/{id}/version/create
Create a new table version
CreateTableVersion 2 params body → 2004004014034044095035XX
POST
/v1/table/{id}/version/describe
Describe a specific table version
DescribeTableVersion 2 params body → 2004004014034045035XX
POST
/v1/table/{id}/version/delete
Delete table version records
BatchDeleteTableVersions 2 params body → 2004004014034045035XX
POST
/v1/table/version/batch-create
Atomically create versions for multiple tables
BatchCreateTableVersions 1 param body → 2004004014034044095035XX
POST
/v1/table/batch-commit
Atomically commit a batch of mixed table operations
BatchCommitTables 1 param body → 2004004014034044095035XX
POST
/v1/table/{id}/alter_columns
Modify existing columns
AlterTableAlterColumns 2 params body → 2004004014034045035XX
POST
/v1/table/{id}/drop_columns
Remove columns from table
AlterTableDropColumns 2 params body → 2004004014034045035XX
POST
/v1/table/{id}/stats
Get table statistics
GetTableStats 2 params body → 2004004014034045035XX
POST
/v1/table/{id}/create_index
Create an index on a table
CreateTableIndex 2 params body → 2004004014034045035XX
POST
/v1/table/{id}/create_scalar_index
Create a scalar index on a table
CreateTableScalarIndex 2 params body → 2004004014034045035XX
POST
/v1/table/{id}/index/list
List indexes on a table
ListTableIndices 2 params body → 2004004014034045035XX
POST
/v1/table/{id}/index/{index_name}/stats
Get table index statistics
DescribeTableIndexStats 3 params body → 2004004014034045035XX
POST
/v1/table/{id}/index/{index_name}/drop
Drop a specific index
DropTableIndex 3 params → 2004004014034045035XX
POST
/v1/table/{id}/tags/list
List all tags for a table
ListTableTags 4 params → 2004004014034045035XX
POST
/v1/table/{id}/tags/version
Get version for a specific tag
GetTableTagVersion 2 params body → 2004004014034045035XX
POST
/v1/table/{id}/declare
Declare a table
DeclareTable 2 params body → 2004004014034044095035XX
POST
/v1/table/{id}/tags/create
Create a new tag
CreateTableTag 2 params body → 2004004014034044095035XX
POST
/v1/table/{id}/tags/delete
Delete a tag
DeleteTableTag 2 params body → 2004004014034045035XX
POST
/v1/table/{id}/tags/update
Update a tag to point to a different version
UpdateTableTag 2 params body → 2004004014034045035XX
POST
/v1/transaction/{id}/describe
Describe information about a transaction
DescribeTransaction 2 params body → 2004004014034045035XX
POST
/v1/transaction/{id}/alter
Alter information of a transaction.
AlterTransaction 2 params body → 2004004014034044095035XX

Schemas 89

The contract defines 89 schemas that model the data the API accepts and returns. The most detailed are CreateTableIndexRequest (15 properties), DescribeTableResponse (12 properties), AlterVirtualColumnEntry (10 properties), CreateTableVersionRequest (9 properties). Each schema is shown below with its type and property counts.

AlterTransactionAction
object
A single action that could be performed to alter a transaction. This action holds the model definition for all types of specific actions models, this is to min…
3 properties
AlterTableDropColumnsResponse
object
2 properties 1 required
UpdateTableTagResponse
object
Response for update tag operation
1 property
TagContents
object
3 properties 2 required
GetTableTagVersionRequest
object
4 properties 1 required
ManifestNamingScheme
string
The naming scheme used for manifest files in the versions/ directory. Known values: - V1: versions/{version}.manifest - Simple version-based naming - V2: versi…
ListTableIndicesRequest
object
6 properties
IndexContent
object
4 properties 4 required
DescribeTableVersionResponse
object
Response containing the table version information
1 property 1 required
DescribeTableIndexStatsResponse
object
5 properties
DeregisterTableRequest
object
The table content remains available in the storage.
3 properties
SetPropertyMode
string
The behavior if the property key already exists. Case insensitive, supports both PascalCase and snakecase. Valid values are: - Overwrite (default): overwrite t…
RenameTableRequest
object
5 properties 1 required
CommitTableResult
object
Result of a single operation within a batch commit. Each result corresponds to one operation in the request, in the same order. Exactly one of the result field…
4 properties
VersionRange
object
A range of versions to delete (start inclusive, end exclusive). Special values: - startversion: 0 with endversion: -1 means ALL versions
2 properties 2 required
JsonArrowDataType
object
JSON representation of an Apache Arrow DataType
3 properties 1 required
ErrorResponse
object
Common JSON error response model
4 properties 1 required
AlterColumnsEntry
object
5 properties 1 required
AlterTransactionSetProperty
object
3 properties
DescribeNamespaceResponse
object
1 property
AlterTransactionResponse
object
2 properties 1 required
DeleteTableTagResponse
object
Response for delete tag operation
1 property
AlterTransactionSetStatus
object
1 property
JsonArrowSchema
object
JSON representation of a Apache Arrow schema.
2 properties 1 required
DropTableIndexResponse
object
Response for drop index operation
1 property
RestoreTableResponse
object
Response for restore table operation
1 property
DeclareTableResponse
object
Response for declaring a table.
5 properties
TableExistsRequest
object
4 properties
BatchDeleteTableVersionsResponse
object
Response for deleting table version records
2 properties
AlterTransactionRequest
object
Alter a transaction with a list of actions. The server should either succeed and apply all actions, or fail and apply no action.
4 properties 1 required
DescribeTransactionRequest
object
3 properties
CommitTableOperation
object
A single operation within a batch commit. Provide exactly one of the operation fields to specify the operation kind.
4 properties
BatchCommitTablesRequest
object
Request to atomically commit a batch of table operations. This replaces BatchCreateTableVersionsRequest with a more general interface that supports mixed opera…
3 properties 1 required
BatchDeleteTableVersionsRequest
object
Request to delete table version records. Supports deleting ranges of versions for efficient bulk cleanup.
4 properties 1 required
DropNamespaceResponse
object
2 properties
DeleteTableTagRequest
object
4 properties 1 required
CreateTableVersionResponse
object
Response for creating a table version
2 properties
UnsetPropertyMode
string
The behavior if the property key to unset does not exist. Case insensitive, supports both PascalCase and snakecase. Valid values are: - Skip (default): skip th…
FragmentStats
object
3 properties 3 required
ListTablesResponse
object
2 properties 1 required
ListNamespacesResponse
object
2 properties 1 required
CreateTableIndexResponse
object
Response for create index operation
1 property
RestoreTableRequest
object
4 properties 1 required
RegisterTableRequest
object
6 properties 1 required
NamespaceExistsRequest
object
3 properties
ListTableIndicesResponse
object
2 properties 1 required
DeclareTableRequest
object
Request for declaring a table.
6 properties
AlterVirtualColumnEntry
object
10 properties
DescribeTableRequest
object
8 properties
DescribeTableResponse
object
12 properties
BatchCreateTableVersionsResponse
object
Response for batch creating table versions. Contains the created versions for each table in the same order as the request.
2 properties 1 required
CreateTableIndexRequest
object
15 properties 2 required
AlterTableAlterColumnsRequest
object
3 properties 1 required
Identity
object
Identity information of a request.
2 properties
CreateNamespaceResponse
object
2 properties
CreateTableTagResponse
object
Response for create tag operation
1 property
RegisterTableResponse
object
3 properties
DropTableResponse
object
4 properties
AlterTransactionUnsetProperty
object
2 properties
DropNamespaceRequest
object
5 properties
DescribeTableIndexStatsRequest
object
5 properties
TransactionStatus
string
The status of a transaction. Case insensitive, supports both PascalCase and snakecase. Valid values are: - Queued: the transaction is queued and not yet starte…
GetTableStatsResponse
object
4 properties 4 required
CreateTableTagRequest
object
5 properties 2 required
CreateTableScalarIndexResponse
object
Response for create scalar index operation
1 property
PageToken
string
An opaque token that allows pagination for list operations (e.g. ListNamespaces). For an initial request of a list operation, if the implementation cannot retu…
DeregisterTableResponse
object
4 properties
FragmentSummary
object
7 properties 7 required
RenameTableResponse
object
1 property
AlterTableAlterColumnsResponse
object
1 property 1 required
DescribeNamespaceRequest
object
3 properties
DescribeTableVersionRequest
object
Request to describe a specific table version
4 properties
ListTableTagsResponse
object
Response containing table tags
2 properties 1 required
JsonArrowField
object
JSON representation of an Apache Arrow field.
4 properties 3 required
DescribeTransactionResponse
object
2 properties 1 required
AlterTableDropColumnsRequest
object
4 properties 1 required
TableVersion
object
6 properties 2 required
GetTableStatsRequest
object
3 properties
BatchCommitTablesResponse
object
Response for a batch commit of table operations. Contains the results of each operation in the same order as the request.
2 properties 1 required
UpdateTableTagRequest
object
5 properties 2 required
CreateNamespaceRequest
object
5 properties
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…
ListTableVersionsResponse
object
2 properties 1 required
BatchCreateTableVersionsRequest
object
Request to atomically create new version entries for multiple tables. The operation is atomic: all versions are created or none are.
3 properties 1 required
CreateTableVersionRequest
object
Request to create a new table version entry. This supports putifnotexists semantics, where the operation fails if the version already exists.
9 properties 2 required
TableBasicStats
object
2 properties 2 required
PageLimit
integer
An inclusive upper bound of the number of results that a caller will receive.
CreateTableVersionEntry
object
An entry for creating a new table version in a batch operation. This supports putifnotexists semantics, where the operation fails if the version already exists.
7 properties 3 required
GetTableTagVersionResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lancedb-metadata-api-openapi.yml Raw ↑

Other APIs LanceDB publishes across the network.

LanceDB Enterprise
AE Profile APIs.io
Lance Format
AE Profile APIs.io
LanceDB Python SDK
AE Profile APIs.io
LanceDB TypeScript SDK
AE Profile APIs.io
LanceDB Rust SDK
AE Profile APIs.io
LanceDB Go SDK
AE Profile APIs.io
LanceDB C Bindings
AE Profile APIs.io
LanceDB MCP Server
AE Profile APIs.io
LanceDB Data API
AE Profile APIs.io
LanceDB Index API
AE Profile APIs.io
LanceDB MaterializedView API
AE Profile APIs.io
LanceDB Namespace API
AE Profile APIs.io
#Metadata
← Back to L APIs
API Details
ID
lancedb:lancedb-metadata-api
Base URL
https://github.com/lancedb/lancedb
Docs
https://docs.lancedb.com/
Provider
LanceDB
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=lancedb-metadata-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/lancedb-metadata-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of LanceDB Metadata 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.