Checks a write task, which has already finished.
Checks a write task, which has already finished. Always reports `succeeded`.
GET /v1/index/tasks/{uid}
| Address | https://api.hanzo.ai/v1/index/tasks/{uid} |
| Method | GET |
| Operation | get_index_tasks_by_uid |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Checks a write task, which has already finished.
Always reports succeeded. Writes here are applied to SQLite before their
EnqueuedTask is returned, so a client polling waitForTask resolves on its
first call rather than waiting for a queue that was never there. The three
timestamps are the same instant for the same reason.
It requires a validated principal but reads no tenant data: the task id it echoes was minted by this process and names nothing about any org.
Request
1 field.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
uid | path | integer | yes |
Response
| Status | Body | Meaning |
|---|---|---|
200 | indexTask | ok |
200 body — 6 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
enqueuedAt | body | string | — | EnqueuedAt, StartedAt and FinishedAt are the same instant: the write was applied before its task id was minted. |
finishedAt | body | string | — | FinishedAt is when the write completed. |
startedAt | body | string | — | StartedAt is when the write began. |
status | body | string | — | Status is always succeeded. |
type | body | string | — | Type names the kind of write, for a client that inspects it. |
uid | body | integer | — | UID echoes the task id that was asked about. |
Failure carries the platform error shape — see Errors.
Examples
hanzo index tasks get 1import { Configuration, IndexApi } from 'hanzoai';
const api = new IndexApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getIndexTasksByUid({ 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_tasks_by_uid(uid='uid')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.IndexAPI.GetIndexTasksByUid(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_tasks_by_uid(&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).getIndexTasksByUid();curl https://api.hanzo.ai/v1/index/tasks/1 \
-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?