Hanzo
OpenapiIndex

Reads an index's filterable attributes.

Reads an index's filterable attributes. Answers the settings subset this surface implements: the attributes a search `filter` may constrain.

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

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

Reads an index's filterable attributes.

Answers the settings subset this surface implements: the attributes a search filter may constrain. An index this org does not hold answers 404 carrying the dialect's index_not_found.

Request

1 field.

FieldInTypeRequiredDescription
uidpathstringyes

Response

StatusBodyMeaning
200indexSettingsok

200 body — 1 field.

FieldInTypeAlwaysDescription
filterableAttributesbodystring[]FilterableAttributes are the document fields a search filter may constrain.

Failure carries the platform error shape — see Errors.

Examples

hanzo index indexes settings get <uid>

Index API · All Hanzo APIs · Interactive reference

How is this guide?

On this page