Hanzo
OpenapiIndex

Pages through the documents in an index.

Pages through the documents in an index. Answers the org's stored documents in insertion order, whole, with the page's bounds and the index's total.

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

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

Pages through the documents in an index.

Answers the org's stored documents in insertion order, whole, with the page's bounds and the index's total. It is the enumeration surface — search ranks by relevance and cannot walk a corpus — so a caller reconciling what it has written reads it here.

An index this org does not hold answers 404 carrying the dialect's index_not_found.

Request

3 fields.

FieldInTypeRequiredDescription
uidpathstringyes
limitquerystring
offsetquerystring

Response

StatusBodyMeaning
200indexDocumentsok

200 body — 4 fields.

FieldInTypeAlwaysDescription
limitbodyintegerLimit is how many documents this page could hold.
offsetbodyintegerOffset is where this page starts.
resultsbodyany[]Results are the documents themselves, exactly as they were stored.
totalbodyintegerTotal is how many documents the index holds altogether.

Failure carries the platform error shape — see Errors.

Examples

hanzo index indexes documents list <uid>

Index API · All Hanzo APIs · Interactive reference

How is this guide?

On this page