Index

Package index is fast full-text search over your own data, typos forgiven.

All API references → · Six flows, four surfaces →


Base URL	`https://api.hanzo.ai`
Operations	17
Auth	`Authorization: Bearer $HANZO_API_KEY`

get_v1_index_health

GET /v1/index/health

get_v1_index_indexes_by_uid_documents_by_id

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

Parameter	In	Type	Required	Description
`uid`	path	string	yes
`id`	path	string	yes

delete_v1_index_indexes_by_uid_documents_by_id

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

Parameter	In	Type	Required	Description
`uid`	path	string	yes
`id`	path	string	yes

post_v1_index_indexes_by_uid_documents_delete-batch

POST /v1/index/indexes/{uid}/documents/delete-batch

Parameter	In	Type	Required	Description
`uid`	path	string	yes

get_v1_index_indexes_by_uid_documents

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

Parameter	In	Type	Required	Description
`uid`	path	string	yes

post_v1_index_indexes_by_uid_documents

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

Parameter	In	Type	Required	Description
`uid`	path	string	yes

put_v1_index_indexes_by_uid_documents

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

Parameter	In	Type	Required	Description
`uid`	path	string	yes

post_v1_index_indexes_by_uid_search

POST /v1/index/indexes/{uid}/search

Parameter	In	Type	Required	Description
`uid`	path	string	yes

get_v1_index_indexes_by_uid_settings

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

Parameter	In	Type	Required	Description
`uid`	path	string	yes

patch_v1_index_indexes_by_uid_settings

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

Parameter	In	Type	Required	Description
`uid`	path	string	yes

get_v1_index_indexes_by_uid

GET /v1/index/indexes/{uid}

Parameter	In	Type	Required	Description
`uid`	path	string	yes

delete_v1_index_indexes_by_uid

DELETE /v1/index/indexes/{uid}

Parameter	In	Type	Required	Description
`uid`	path	string	yes

get_v1_index_indexes

GET /v1/index/indexes

post_v1_index_indexes

POST /v1/index/indexes

get_v1_index_stats

GET /v1/index/stats

get_v1_index_tasks_by_uid

GET /v1/index/tasks/{uid}

Parameter	In	Type	Required	Description
`uid`	path	string	yes

get_v1_index_version

GET /v1/index/version

All Hanzo APIs · Interactive reference

Index

On this page