Hanzo
OpenapiIndex

Checks a write task, which has already finished.

Checks a write task, which has already finished. Always reports `succeeded`.

GET /v1/index/tasks/{uid}

Addresshttps://api.hanzo.ai/v1/index/tasks/{uid}
MethodGET
Operationget_index_tasks_by_uid
AuthAuthorization: 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.

FieldInTypeRequiredDescription
uidpathintegeryes

Response

StatusBodyMeaning
200indexTaskok

200 body — 6 fields.

FieldInTypeAlwaysDescription
enqueuedAtbodystringEnqueuedAt, StartedAt and FinishedAt are the same instant: the write was applied before its task id was minted.
finishedAtbodystringFinishedAt is when the write completed.
startedAtbodystringStartedAt is when the write began.
statusbodystringStatus is always succeeded.
typebodystringType names the kind of write, for a client that inspects it.
uidbodyintegerUID echoes the task id that was asked about.

Failure carries the platform error shape — see Errors.

Examples

hanzo index tasks get 1

Index API · All Hanzo APIs · Interactive reference

How is this guide?

On this page