---
title: "Create a scalar index on a table"
method: POST
path: "/v1/table/{id}/create_scalar_index"
tags: ["Table", "Index", "Metadata"]
---

# Create a scalar index on a table

`POST /v1/table/{id}/create_scalar_index`

Create a scalar index on a table field for faster filtering operations.
Supports scalar indexes (BTREE, BITMAP, LABEL_LIST, FTS, etc.).
This is an alias for CreateTableIndex specifically for scalar indexes.
Index creation is handled asynchronously.
Use the `ListTableIndices` and `DescribeTableIndexStats` operations to monitor index creation progress.

## Path parameters

- `id` string, required

## Query parameters

- `delimiter` string

## Request body

- CreateTableIndexRequest
  - `identity` Identity — Identity information of a request.
    - `api_key` string — API key for authentication. REST NAMESPACE ONLY This is passed via the `x-api-key` header.
    - `auth_token` string — Bearer token for authentication. REST NAMESPACE ONLY This is passed via the `Authorization` header with the Bearer scheme (e.g., `Bearer <token>`).
  - `context` unknown
  - `id` string[]
  - `branch` string — Branch to target. When not specified, the main branch is used.
  - `column` string, required — Lance field path to create the index on. Nested fields use dot-separated segments; use backtick-quoted segments for literal dots and double backticks inside quoted segments. Use canonical full paths for display and errors; leaf names alone only identify top-level fields; invalid or unresolved paths should return InvalidInput or TableColumnNotFound.
  - `index_type` string, required — Type of index to create (e.g., BTREE, BITMAP, LABEL_LIST, IVF_FLAT, IVF_PQ, IVF_HNSW_SQ, FTS)
  - `name` string, nullable — Optional name for the index. If not provided, a name will be auto-generated.
  - `distance_type` string — Distance metric type for vector indexes (e.g., l2, cosine, dot)
  - `with_position` boolean, nullable — Optional FTS parameter for position tracking
  - `base_tokenizer` string, nullable — Optional FTS parameter for base tokenizer
  - `language` string, nullable — Optional FTS parameter for language
  - `max_token_length` integer, nullable — Optional FTS parameter for maximum token length
  - `lower_case` boolean, nullable — Optional FTS parameter for lowercase conversion
  - `stem` boolean, nullable — Optional FTS parameter for stemming
  - `remove_stop_words` boolean, nullable — Optional FTS parameter for stop word removal
  - `ascii_folding` boolean, nullable — Optional FTS parameter for ASCII folding

## Response `200`

Scalar index created successfully

- CreateTableScalarIndexResponse — Response for create scalar index operation
  - `context` unknown
  - `transaction_id` string — Optional transaction identifier

## Other responses

- `400` — Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure, such as invalid json. Usually serves application/json content, although in some cases simple text/plain content might be returned by the server's middleware.
- `401` — Unauthorized. The request lacks valid authentication credentials for the operation.
- `403` — Forbidden. Authenticated user does not have the necessary permissions.
- `404` — A server-side problem that means can not find the specified resource.
- `503` — The service is not ready to handle the request. The client should wait and retry. The service may additionally send a Retry-After header to indicate when to retry.
- `5XX` — A server-side problem that might not be addressable from the client side. Used for server 5xx errors without more specific documentation in individual routes.

---

[API](https://skmtc.net/lance-format/apis/lance-namespace-specification.md) · [All operations](https://skmtc.net/lance-format/apis/lance-namespace-specification/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lance-format/lance-namespace-specification/versions/f09656f7f568/schema)