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 Transaction API

Operations that are related to a transaction

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

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

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

3 operations 3 paths 29 schemas 3 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 Transaction 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 3

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

Transaction 3

Operations that are related to a transaction

POST
/v1/table/batch-commit
Atomically commit a batch of mixed table operations
BatchCommitTables 1 param body → 2004004014034044095035XX
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 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are CreateTableVersionRequest (9 properties), DeclareTableRequest (6 properties), TableVersion (6 properties), DeclareTableResponse (5 properties). Each schema is shown below with its type and property counts.

DeclareTableRequest
object
Request for declaring a table.
6 properties
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
DeclareTableResponse
object
Response for declaring a table.
5 properties
BatchDeleteTableVersionsResponse
object
Response for deleting table version records
2 properties
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…
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
DescribeTransactionResponse
object
2 properties 1 required
DescribeTransactionRequest
object
3 properties
TableVersion
object
6 properties 2 required
CommitTableOperation
object
A single operation within a batch commit. Provide exactly one of the operation fields to specify the operation kind.
4 properties
Identity
object
Identity information of a request.
2 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
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…
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
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…
CreateTableVersionResponse
object
Response for creating a table version
2 properties
AlterTransactionUnsetProperty
object
2 properties
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
ErrorResponse
object
Common JSON error response model
4 properties 1 required
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…
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…
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
AlterTransactionSetProperty
object
3 properties
AlterTransactionResponse
object
2 properties 1 required
AlterTransactionSetStatus
object
1 property
DeregisterTableResponse
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lancedb-transaction-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 Data API
LanceDB Index API
LanceDB MaterializedView API
LanceDB Metadata API
Where this information came from

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