OpenapiIndex
Reads an index's filterable attributes.
Reads an index's filterable attributes. Answers the settings subset this surface implements: the attributes a search `filter` may constrain.
GET /v1/index/indexes/{uid}/settings
| Address | https://api.hanzo.ai/v1/index/indexes/{uid}/settings |
| Method | GET |
| Operation | get_index_indexes_by_uid_settings |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Reads an index's filterable attributes.
Answers the settings subset this surface implements: the attributes a search
filter may constrain. An index this org does not hold answers 404 carrying
the dialect's index_not_found.
Request
1 field.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
uid | path | string | yes |
Response
| Status | Body | Meaning |
|---|---|---|
200 | indexSettings | ok |
200 body — 1 field.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
filterableAttributes | body | string[] | — | FilterableAttributes are the document fields a search filter may constrain. |
Failure carries the platform error shape — see Errors.
Examples
hanzo index indexes settings get <uid>import { Configuration, IndexApi } from 'hanzoai';
const api = new IndexApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getIndexIndexesByUidSettings({ uid: 'uid' });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_by_uid_settings(uid='uid')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.IndexAPI.GetIndexIndexesByUidSettings(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::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_by_uid_settings(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.IndexApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new IndexApi(client).getIndexIndexesByUidSettings();curl https://api.hanzo.ai/v1/index/indexes/<uid>/settings \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches index through the index tool, which names its 17 operations with its own verbs — this one among them, under a name only the door 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"
}
}
}'How is this guide?