List indexes

Lists the indexes your org holds.

GET /v1/index/indexes

Index → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/index/indexes`
Method	`GET`
Operation	`get_index_indexes`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Lists the indexes your org holds.

Answers every index in the caller's own org with its primary key and timestamps. Without it an index whose uid a caller has forgotten is unreachable — there is no other way to enumerate what an org holds. The page is the whole set: an org's index count is small by construction, so limit and total both report it.

The tenant is the org minted from the VALIDATED bearer's owner claim, never a client-supplied header, and two orgs may both hold an index named "messages" without either seeing the other. Without a validated principal the answer is 403 carrying the dialect's invalid_api_key body.

Request

GET /v1/index/indexes takes no parameters and no body — the credential is the whole request.

Response

Status	Body	Meaning
`200`	index.indexList	ok
`default`	problem-details	refused

200 body — 8 fields.

Field	In	Type	Always	Description
`limit`	body	integer (int64)	—	Limit is how many rows this page could hold.
`offset`	body	integer (int64)	—	Offset is where this page starts.
`results`	body	index.indexView[]	—	Results are the index definitions themselves.
`results[].createdAt`	body	string	—	CreatedAt is when this org first created the index, RFC 3339.
`results[].primaryKey`	body	string	—	PrimaryKey is the document field that identifies a row; an upsert is keyed on it.
`results[].uid`	body	string	—	UID is the index's name within the org.
`results[].updatedAt`	body	string	—	UpdatedAt is when the index or its settings last changed, RFC 3339.
`total`	body	integer (int64)	—	Total is how many indexes the org holds altogether.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo index indexes list

.ts

.py

.go

.rs

.java

import { Configuration, IndexApi } from 'hanzoai';

const api = new IndexApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getIndexIndexes();

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import IndexApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = IndexApi(client).get_index_indexes()

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.IndexAPI.GetIndexIndexes(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, index_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = index_api::get_index_indexes(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.IndexApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new IndexApi(client).getIndexIndexes();

curl https://api.hanzo.ai/v1/index/indexes \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches index through the index tool, which names its 14 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "get_index_health"
         }
       }
     }'

Index API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousGet indexes NextList stats