Create an index on a table

curl --request POST \
  --url http://localhost:2333/v1/table/{id}/create_index \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "column": "<string>",
  "index_type": "<string>",
  "identity": {
    "api_key": "<string>",
    "auth_token": "<string>"
  },
  "context": {},
  "id": [
    "<string>"
  ],
  "branch": "<string>",
  "name": "<string>",
  "distance_type": "<string>",
  "num_partitions": 2,
  "num_sub_vectors": 2,
  "num_bits": 2,
  "sample_rate": 2,
  "max_iterations": 2,
  "target_partition_size": 2,
  "m": 2,
  "ef_construction": 2,
  "with_position": true,
  "base_tokenizer": "<string>",
  "language": "<string>",
  "max_token_length": 1,
  "lower_case": true,
  "stem": true,
  "remove_stop_words": true,
  "ascii_folding": true
}
'

import requests

url = "http://localhost:2333/v1/table/{id}/create_index"

payload = {
    "column": "<string>",
    "index_type": "<string>",
    "identity": {
        "api_key": "<string>",
        "auth_token": "<string>"
    },
    "context": {},
    "id": ["<string>"],
    "branch": "<string>",
    "name": "<string>",
    "distance_type": "<string>",
    "num_partitions": 2,
    "num_sub_vectors": 2,
    "num_bits": 2,
    "sample_rate": 2,
    "max_iterations": 2,
    "target_partition_size": 2,
    "m": 2,
    "ef_construction": 2,
    "with_position": True,
    "base_tokenizer": "<string>",
    "language": "<string>",
    "max_token_length": 1,
    "lower_case": True,
    "stem": True,
    "remove_stop_words": True,
    "ascii_folding": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    column: '<string>',
    index_type: '<string>',
    identity: {api_key: '<string>', auth_token: '<string>'},
    context: {},
    id: ['<string>'],
    branch: '<string>',
    name: '<string>',
    distance_type: '<string>',
    num_partitions: 2,
    num_sub_vectors: 2,
    num_bits: 2,
    sample_rate: 2,
    max_iterations: 2,
    target_partition_size: 2,
    m: 2,
    ef_construction: 2,
    with_position: true,
    base_tokenizer: '<string>',
    language: '<string>',
    max_token_length: 1,
    lower_case: true,
    stem: true,
    remove_stop_words: true,
    ascii_folding: true
  })
};

fetch('http://localhost:2333/v1/table/{id}/create_index', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "2333",
  CURLOPT_URL => "http://localhost:2333/v1/table/{id}/create_index",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'column' => '<string>',
    'index_type' => '<string>',
    'identity' => [
        'api_key' => '<string>',
        'auth_token' => '<string>'
    ],
    'context' => [
        
    ],
    'id' => [
        '<string>'
    ],
    'branch' => '<string>',
    'name' => '<string>',
    'distance_type' => '<string>',
    'num_partitions' => 2,
    'num_sub_vectors' => 2,
    'num_bits' => 2,
    'sample_rate' => 2,
    'max_iterations' => 2,
    'target_partition_size' => 2,
    'm' => 2,
    'ef_construction' => 2,
    'with_position' => true,
    'base_tokenizer' => '<string>',
    'language' => '<string>',
    'max_token_length' => 1,
    'lower_case' => true,
    'stem' => true,
    'remove_stop_words' => true,
    'ascii_folding' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:2333/v1/table/{id}/create_index"

	payload := strings.NewReader("{\n  \"column\": \"<string>\",\n  \"index_type\": \"<string>\",\n  \"identity\": {\n    \"api_key\": \"<string>\",\n    \"auth_token\": \"<string>\"\n  },\n  \"context\": {},\n  \"id\": [\n    \"<string>\"\n  ],\n  \"branch\": \"<string>\",\n  \"name\": \"<string>\",\n  \"distance_type\": \"<string>\",\n  \"num_partitions\": 2,\n  \"num_sub_vectors\": 2,\n  \"num_bits\": 2,\n  \"sample_rate\": 2,\n  \"max_iterations\": 2,\n  \"target_partition_size\": 2,\n  \"m\": 2,\n  \"ef_construction\": 2,\n  \"with_position\": true,\n  \"base_tokenizer\": \"<string>\",\n  \"language\": \"<string>\",\n  \"max_token_length\": 1,\n  \"lower_case\": true,\n  \"stem\": true,\n  \"remove_stop_words\": true,\n  \"ascii_folding\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:2333/v1/table/{id}/create_index")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"column\": \"<string>\",\n  \"index_type\": \"<string>\",\n  \"identity\": {\n    \"api_key\": \"<string>\",\n    \"auth_token\": \"<string>\"\n  },\n  \"context\": {},\n  \"id\": [\n    \"<string>\"\n  ],\n  \"branch\": \"<string>\",\n  \"name\": \"<string>\",\n  \"distance_type\": \"<string>\",\n  \"num_partitions\": 2,\n  \"num_sub_vectors\": 2,\n  \"num_bits\": 2,\n  \"sample_rate\": 2,\n  \"max_iterations\": 2,\n  \"target_partition_size\": 2,\n  \"m\": 2,\n  \"ef_construction\": 2,\n  \"with_position\": true,\n  \"base_tokenizer\": \"<string>\",\n  \"language\": \"<string>\",\n  \"max_token_length\": 1,\n  \"lower_case\": true,\n  \"stem\": true,\n  \"remove_stop_words\": true,\n  \"ascii_folding\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:2333/v1/table/{id}/create_index")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"column\": \"<string>\",\n  \"index_type\": \"<string>\",\n  \"identity\": {\n    \"api_key\": \"<string>\",\n    \"auth_token\": \"<string>\"\n  },\n  \"context\": {},\n  \"id\": [\n    \"<string>\"\n  ],\n  \"branch\": \"<string>\",\n  \"name\": \"<string>\",\n  \"distance_type\": \"<string>\",\n  \"num_partitions\": 2,\n  \"num_sub_vectors\": 2,\n  \"num_bits\": 2,\n  \"sample_rate\": 2,\n  \"max_iterations\": 2,\n  \"target_partition_size\": 2,\n  \"m\": 2,\n  \"ef_construction\": 2,\n  \"with_position\": true,\n  \"base_tokenizer\": \"<string>\",\n  \"language\": \"<string>\",\n  \"max_token_length\": 1,\n  \"lower_case\": true,\n  \"stem\": true,\n  \"remove_stop_words\": true,\n  \"ascii_folding\": true\n}"

response = http.request(request)
puts response.read_body

{
  "context": {},
  "transaction_id": "<string>"
}

{
  "type": "/errors/bad-request",
  "title": "Malformed request",
  "status": 400,
  "detail": "",
  "instance": "/v1/namespaces"
}

{
  "type": "/errors/unauthorized-request",
  "title": "No valid authentication credentials for the operation",
  "status": 401,
  "detail": "",
  "instance": "/v1/namespaces"
}

{
  "type": "/errors/forbidden-request",
  "title": "Not authorized to make this request",
  "status": 403,
  "detail": "",
  "instance": "/v1/namespaces"
}

{
  "type": "/errors/not-found-error",
  "title": "Not found Error",
  "status": 404,
  "detail": "",
  "instance": "/v1/namespaces/{ns}"
}

{
  "type": "/errors/service-unavailable",
  "title": "Slow down",
  "status": 503,
  "detail": "",
  "instance": "/v1/namespaces"
}

{
  "type": "/errors/server-error",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "",
  "instance": "/v1/namespaces"
}

POST

table

{id}

create_index

Create an index on a table

curl --request POST \
  --url http://localhost:2333/v1/table/{id}/create_index \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "column": "<string>",
  "index_type": "<string>",
  "identity": {
    "api_key": "<string>",
    "auth_token": "<string>"
  },
  "context": {},
  "id": [
    "<string>"
  ],
  "branch": "<string>",
  "name": "<string>",
  "distance_type": "<string>",
  "num_partitions": 2,
  "num_sub_vectors": 2,
  "num_bits": 2,
  "sample_rate": 2,
  "max_iterations": 2,
  "target_partition_size": 2,
  "m": 2,
  "ef_construction": 2,
  "with_position": true,
  "base_tokenizer": "<string>",
  "language": "<string>",
  "max_token_length": 1,
  "lower_case": true,
  "stem": true,
  "remove_stop_words": true,
  "ascii_folding": true
}
'

import requests

url = "http://localhost:2333/v1/table/{id}/create_index"

payload = {
    "column": "<string>",
    "index_type": "<string>",
    "identity": {
        "api_key": "<string>",
        "auth_token": "<string>"
    },
    "context": {},
    "id": ["<string>"],
    "branch": "<string>",
    "name": "<string>",
    "distance_type": "<string>",
    "num_partitions": 2,
    "num_sub_vectors": 2,
    "num_bits": 2,
    "sample_rate": 2,
    "max_iterations": 2,
    "target_partition_size": 2,
    "m": 2,
    "ef_construction": 2,
    "with_position": True,
    "base_tokenizer": "<string>",
    "language": "<string>",
    "max_token_length": 1,
    "lower_case": True,
    "stem": True,
    "remove_stop_words": True,
    "ascii_folding": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    column: '<string>',
    index_type: '<string>',
    identity: {api_key: '<string>', auth_token: '<string>'},
    context: {},
    id: ['<string>'],
    branch: '<string>',
    name: '<string>',
    distance_type: '<string>',
    num_partitions: 2,
    num_sub_vectors: 2,
    num_bits: 2,
    sample_rate: 2,
    max_iterations: 2,
    target_partition_size: 2,
    m: 2,
    ef_construction: 2,
    with_position: true,
    base_tokenizer: '<string>',
    language: '<string>',
    max_token_length: 1,
    lower_case: true,
    stem: true,
    remove_stop_words: true,
    ascii_folding: true
  })
};

fetch('http://localhost:2333/v1/table/{id}/create_index', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "2333",
  CURLOPT_URL => "http://localhost:2333/v1/table/{id}/create_index",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'column' => '<string>',
    'index_type' => '<string>',
    'identity' => [
        'api_key' => '<string>',
        'auth_token' => '<string>'
    ],
    'context' => [
        
    ],
    'id' => [
        '<string>'
    ],
    'branch' => '<string>',
    'name' => '<string>',
    'distance_type' => '<string>',
    'num_partitions' => 2,
    'num_sub_vectors' => 2,
    'num_bits' => 2,
    'sample_rate' => 2,
    'max_iterations' => 2,
    'target_partition_size' => 2,
    'm' => 2,
    'ef_construction' => 2,
    'with_position' => true,
    'base_tokenizer' => '<string>',
    'language' => '<string>',
    'max_token_length' => 1,
    'lower_case' => true,
    'stem' => true,
    'remove_stop_words' => true,
    'ascii_folding' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:2333/v1/table/{id}/create_index"

	payload := strings.NewReader("{\n  \"column\": \"<string>\",\n  \"index_type\": \"<string>\",\n  \"identity\": {\n    \"api_key\": \"<string>\",\n    \"auth_token\": \"<string>\"\n  },\n  \"context\": {},\n  \"id\": [\n    \"<string>\"\n  ],\n  \"branch\": \"<string>\",\n  \"name\": \"<string>\",\n  \"distance_type\": \"<string>\",\n  \"num_partitions\": 2,\n  \"num_sub_vectors\": 2,\n  \"num_bits\": 2,\n  \"sample_rate\": 2,\n  \"max_iterations\": 2,\n  \"target_partition_size\": 2,\n  \"m\": 2,\n  \"ef_construction\": 2,\n  \"with_position\": true,\n  \"base_tokenizer\": \"<string>\",\n  \"language\": \"<string>\",\n  \"max_token_length\": 1,\n  \"lower_case\": true,\n  \"stem\": true,\n  \"remove_stop_words\": true,\n  \"ascii_folding\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:2333/v1/table/{id}/create_index")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"column\": \"<string>\",\n  \"index_type\": \"<string>\",\n  \"identity\": {\n    \"api_key\": \"<string>\",\n    \"auth_token\": \"<string>\"\n  },\n  \"context\": {},\n  \"id\": [\n    \"<string>\"\n  ],\n  \"branch\": \"<string>\",\n  \"name\": \"<string>\",\n  \"distance_type\": \"<string>\",\n  \"num_partitions\": 2,\n  \"num_sub_vectors\": 2,\n  \"num_bits\": 2,\n  \"sample_rate\": 2,\n  \"max_iterations\": 2,\n  \"target_partition_size\": 2,\n  \"m\": 2,\n  \"ef_construction\": 2,\n  \"with_position\": true,\n  \"base_tokenizer\": \"<string>\",\n  \"language\": \"<string>\",\n  \"max_token_length\": 1,\n  \"lower_case\": true,\n  \"stem\": true,\n  \"remove_stop_words\": true,\n  \"ascii_folding\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:2333/v1/table/{id}/create_index")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"column\": \"<string>\",\n  \"index_type\": \"<string>\",\n  \"identity\": {\n    \"api_key\": \"<string>\",\n    \"auth_token\": \"<string>\"\n  },\n  \"context\": {},\n  \"id\": [\n    \"<string>\"\n  ],\n  \"branch\": \"<string>\",\n  \"name\": \"<string>\",\n  \"distance_type\": \"<string>\",\n  \"num_partitions\": 2,\n  \"num_sub_vectors\": 2,\n  \"num_bits\": 2,\n  \"sample_rate\": 2,\n  \"max_iterations\": 2,\n  \"target_partition_size\": 2,\n  \"m\": 2,\n  \"ef_construction\": 2,\n  \"with_position\": true,\n  \"base_tokenizer\": \"<string>\",\n  \"language\": \"<string>\",\n  \"max_token_length\": 1,\n  \"lower_case\": true,\n  \"stem\": true,\n  \"remove_stop_words\": true,\n  \"ascii_folding\": true\n}"

response = http.request(request)
puts response.read_body

{
  "context": {},
  "transaction_id": "<string>"
}

{
  "type": "/errors/bad-request",
  "title": "Malformed request",
  "status": 400,
  "detail": "",
  "instance": "/v1/namespaces"
}

{
  "type": "/errors/unauthorized-request",
  "title": "No valid authentication credentials for the operation",
  "status": 401,
  "detail": "",
  "instance": "/v1/namespaces"
}

{
  "type": "/errors/forbidden-request",
  "title": "Not authorized to make this request",
  "status": 403,
  "detail": "",
  "instance": "/v1/namespaces"
}

{
  "type": "/errors/not-found-error",
  "title": "Not found Error",
  "status": 404,
  "detail": "",
  "instance": "/v1/namespaces/{ns}"
}

{
  "type": "/errors/service-unavailable",
  "title": "Slow down",
  "status": 503,
  "detail": "",
  "instance": "/v1/namespaces"
}

{
  "type": "/errors/server-error",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "",
  "instance": "/v1/namespaces"
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

string

required

string identifier of an object in a namespace, following the Lance Namespace spec. When the value is equal to the delimiter, it represents the root namespace. For example, v1/namespace/$/list performs a ListNamespace on the root namespace.

Query Parameters

delimiter

string

An optional delimiter of the string identifier, following the Lance Namespace spec. When not specified, the $ delimiter must be used.

Body

application/json

Index creation request

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.

Minimum string length: 1

index_type

string

required

Type of index to create (e.g., BTREE, BITMAP, LABEL_LIST, IVF_FLAT, IVF_PQ, IVF_HNSW_SQ, FTS)

identity

object

Identity information of a request.

Show child attributes

context

object

Arbitrary context as key-value pairs. How to use the context is custom to the specific implementation.

On a request, it carries caller-provided context to the implementation. On a response, it carries implementation-provided context back to the caller.

REST NAMESPACE ONLY Context entries are mapped to and from HTTP headers using the header. prefix:

On a request, any entry whose key starts with header. is sent as an HTTP request header with the prefix stripped. For example, the entry {"header.Authorization": "Bearer abc"} is sent as the request header Authorization: Bearer abc.
On a response, every HTTP response header is returned as an entry whose key is the header name prefixed with header.. For example, the response header x-request-id: abc123 is returned as the entry {"header.x-request-id": "abc123"}.

Show child attributes

string[]

branch

string

Branch to target. When not specified, the main branch is used.

name

string | null

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)

num_partitions

integer | null

Optional vector index parameter for the number of IVF partitions. Applies to all IVF index types.

Required range: x >= 1

num_sub_vectors

integer | null

Optional vector index parameter for the number of PQ sub-vectors. Applies to IVF_PQ only.

Required range: x >= 1

num_bits

integer | null

Optional vector index parameter for the number of bits used by the quantizer.

Required range: x >= 1

sample_rate

integer | null

Optional vector index parameter for the per-partition sample rate used during IVF training.

Required range: x >= 1

max_iterations

integer | null

Optional vector index parameter for the maximum number of IVF k-means training iterations.

Required range: x >= 1

target_partition_size

integer | null

Optional vector index parameter for the target partition size. Alternative to num_partitions.

Required range: x >= 1

integer | null

Optional vector index parameter for the number of edges per node in the HNSW graph. Applies to HNSW index types.

Required range: x >= 1

ef_construction

integer | null

Optional vector index parameter for the number of candidates evaluated during HNSW graph construction. Applies to HNSW index types.

Required range: x >= 1

with_position

boolean | null

Optional FTS parameter for position tracking

base_tokenizer

string | null

Optional FTS parameter for base tokenizer

language

string | null

Optional FTS parameter for language

max_token_length

integer | null

Optional FTS parameter for maximum token length

Required range: x >= 0

lower_case

boolean | null

Optional FTS parameter for lowercase conversion

stem

boolean | null

Optional FTS parameter for stemming

remove_stop_words

boolean | null

Optional FTS parameter for stop word removal

ascii_folding

boolean | null

Optional FTS parameter for ASCII folding

Response

Index created successfully

Response for create index operation

context

object

Arbitrary context as key-value pairs. How to use the context is custom to the specific implementation.

On a request, it carries caller-provided context to the implementation. On a response, it carries implementation-provided context back to the caller.

REST NAMESPACE ONLY Context entries are mapped to and from HTTP headers using the header. prefix:

On a request, any entry whose key starts with header. is sent as an HTTP request header with the prefix stripped. For example, the entry {"header.Authorization": "Bearer abc"} is sent as the request header Authorization: Bearer abc.
On a response, every HTTP response header is returned as an entry whose key is the header name prefixed with header.. For example, the response header x-request-id: abc123 is returned as the entry {"header.x-request-id": "abc123"}.

Show child attributes

transaction_id

string

Optional transaction identifier