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

Operations that are related to an index

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

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

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

5 operations 5 paths 14 schemas 5 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 Index 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 5

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

Index 5

Operations that are related to an index

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

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are CreateTableIndexRequest (15 properties), ListTableIndicesRequest (6 properties), DescribeTableIndexStatsResponse (5 properties), DescribeTableIndexStatsRequest (5 properties). Each schema is shown below with its type and property counts.

DropTableIndexResponse
object
Response for drop index operation
1 property
CreateTableIndexRequest
object
15 properties 2 required
ListTableIndicesRequest
object
6 properties
Identity
object
Identity information of a request.
2 properties
IndexContent
object
4 properties 4 required
DescribeTableIndexStatsResponse
object
5 properties
DescribeTableIndexStatsRequest
object
5 properties
PageLimit
integer
An inclusive upper bound of the number of results that a caller will receive.
ErrorResponse
object
Common JSON error response model
4 properties 1 required
CreateTableIndexResponse
object
Response for create index operation
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…
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…
ListTableIndicesResponse
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lancedb-index-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 MaterializedView API
LanceDB Metadata API
LanceDB Namespace API
Where this information came from

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