OpenapiIndex
Identifies the search implementation answering.
Identifies the search implementation answering.
GET /v1/index/version
| Address | https://api.hanzo.ai/v1/index/version |
| Method | GET |
| Operation | get_index_version |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Identifies the search implementation answering.
Reports the dialect's version shape with commitSha naming this
implementation rather than a Meilisearch build, so a client that logs the
version records which server answered instead of implying a release of
software this is not. It requires no principal and reads no tenant data.
Request
GET /v1/index/version takes no parameters and no body — the credential is the whole request.
Response
| Status | Body | Meaning |
|---|---|---|
200 | indexVersion | ok |
200 body — 3 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
commitDate | body | string | — | CommitDate is empty here: this surface is a dialect implementation, not a build of Meilisearch, so there is no upstream commit to date. |
commitSha | body | string | — | CommitSha names the implementation (hanzo-cloud) rather than a build hash, so a client logging it records which server answered instead of implying a… |
pkgVersion | body | string | — | PkgVersion is this dialect implementation's own version. |
Failure carries the platform error shape — see Errors.
Examples
hanzo index versionimport { Configuration, IndexApi } from 'hanzoai';
const api = new IndexApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getIndexVersion();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_version()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.IndexAPI.GetIndexVersion(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_version(&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).getIndexVersion();curl https://api.hanzo.ai/v1/index/version \
-H "Authorization: Bearer $HANZO_API_KEY"Tool index, op get_index_version — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "index",
"arguments": {
"op": "get_index_version",
"input": {}
}
}
}'How is this guide?