Hanzo
OpenapiIndex

Reads one document by its primary key.

Reads one document by its primary key. Answers the stored document exactly as it was written — this surface keeps documents whole rather than projecting…

GET /v1/index/indexes/{uid}/documents/{id}

Addresshttps://api.hanzo.ai/v1/index/indexes/{uid}/documents/{id}
MethodGET
Operationget_index_indexes_by_uid_documents_by_id
AuthAuthorization: Bearer $HANZO_API_KEY

Reads one document by its primary key.

Answers the stored document exactly as it was written — this surface keeps documents whole rather than projecting them, so what comes back is what went in. A primary key this index does not hold answers 404 carrying the dialect's document_not_found; an index this org does not hold answers index_not_found, and the two are different facts a client acts on differently.

Request

2 fields.

FieldInTypeRequiredDescription
uidpathstringyes
idpathstringyes

Response

StatusBodyMeaning
200ok

200 body — 1 field.

FieldInTypeAlwaysDescription
(body)bodyanyyes

Failure carries the platform error shape — see Errors.

Examples

hanzo index indexes documents get <uid> <id>

Index API · All Hanzo APIs · Interactive reference

How is this guide?

On this page