API Reference
Hanzo Nexus API Hanzo Nexus is a knowledge base and RAG (Retrieval-Augmented Generation) platform. It provides document management, vector embeddings, semantic search, and AI-powered question answering across organiz
Hanzo Nexus is a knowledge base and RAG (Retrieval-Augmented Generation) platform. It provides document management, vector embeddings, semantic search, and AI-powered question answering across organiz
All Hanzo APIs share one bearer credential and common error and pagination conventions. See API conventions .
curl -H "Authorization: Bearer $HANZO_API_KEY " https://nexus.hanzo.ai Method Endpoint Description GET/v1/nexus/get-accountget Account POST/v1/nexus/signinsignin POST/v1/nexus/signoutsignout
Method Endpoint Description GET/v1/nexus/get-activitiesget Activities
Method Endpoint Description POST/v1/nexus/add-applicationadd Application POST/v1/nexus/delete-applicationdelete Application POST/v1/nexus/deploy-applicationdeploy Application GET/v1/nexus/get-applicationget Application GET/v1/nexus/get-application-statusget Application Status GET/v1/nexus/get-applicationsget Applications POST/v1/nexus/undeploy-applicationundeploy Application POST/v1/nexus/update-applicationupdate Application
Method Endpoint Description POST/v1/nexus/add-articleadd Article POST/v1/nexus/delete-articledelete Article GET/v1/nexus/get-articleget Article GET/v1/nexus/get-articlesget Articles GET/v1/nexus/get-global-articlesget Global Articles POST/v1/nexus/update-articleupdate Article
Method Endpoint Description POST/v1/nexus/add-chatadd Chat POST/v1/nexus/delete-chatdelete Chat GET/v1/nexus/get-chatget Chat GET/v1/nexus/get-chatsget Chats GET/v1/nexus/get-global-chatsget Global Chats POST/v1/nexus/update-chatupdate Chat
Method Endpoint Description POST/v1/nexus/add-connectionadd Connection GET/v1/nexus/add-node-tunneladd Node Tunnel POST/v1/nexus/delete-connectiondelete Connection GET/v1/nexus/get-connectionget Connection GET/v1/nexus/get-connectionsget Connections GET/v1/nexus/get-node-tunnelget Node Tunnel POST/v1/nexus/start-connectionstart Connection POST/v1/nexus/stop-connectionstop Connection POST/v1/nexus/update-connectionupdate Connection
Method Endpoint Description POST/v1/nexus/add-containeradd Container POST/v1/nexus/delete-containerdelete Container GET/v1/nexus/get-containerget Container GET/v1/nexus/get-containersget Containers POST/v1/nexus/update-containerupdate Container
Method Endpoint Description GET/v1/nexus/get-k8s-statusget K8s Status
Method Endpoint Description POST/v1/nexus/activate-fileactivate File POST/v1/nexus/add-fileadd File POST/v1/nexus/delete-filedelete File GET/v1/nexus/get-active-fileget Active File POST/v1/nexus/update-fileupdate File POST/v1/nexus/upload-fileupload File
Method Endpoint Description POST/v1/nexus/add-formadd Form POST/v1/nexus/delete-formdelete Form GET/v1/nexus/get-formget Form GET/v1/nexus/get-form-dataget Form Data GET/v1/nexus/get-formsget Forms GET/v1/nexus/get-global-formsget Global Forms POST/v1/nexus/update-formupdate Form
Method Endpoint Description POST/v1/nexus/add-imageadd Image POST/v1/nexus/delete-imagedelete Image GET/v1/nexus/get-imageget Image GET/v1/nexus/get-imagesget Images POST/v1/nexus/update-imageupdate Image
Method Endpoint Description POST/v1/nexus/add-machineadd Machine POST/v1/nexus/delete-machinedelete Machine GET/v1/nexus/get-machineget Machine GET/v1/nexus/get-machinesget Machines POST/v1/nexus/update-machineupdate Machine
Method Endpoint Description POST/v1/nexus/add-messageadd Message POST/v1/nexus/delete-messagedelete Message GET/v1/nexus/get-Messagesget Messages GET/v1/nexus/get-answerget Answer GET/v1/nexus/get-global-messagesget Global Messages GET/v1/nexus/get-messageget Message GET/v1/nexus/get-message-answerget Message Answer POST/v1/nexus/update-messageupdate Message
Method Endpoint Description POST/v1/nexus/add-nodeadd Node POST/v1/nexus/delete-nodedelete Node GET/v1/nexus/get-nodeget Node GET/v1/nexus/get-nodesget Nodes POST/v1/nexus/update-nodeupdate Node
Method Endpoint Description POST/v1/nexus/chat/completionschat Completions
Method Endpoint Description POST/v1/nexus/add-permissionadd Permission POST/v1/nexus/delete-permissiondelete Permission GET/v1/nexus/get-permissionget Permission GET/v1/nexus/get-permissionsget Permissions POST/v1/nexus/update-permissionupdate Permission
Method Endpoint Description POST/v1/nexus/add-podadd Pod POST/v1/nexus/delete-poddelete Pod GET/v1/nexus/get-podget Pod GET/v1/nexus/get-podsget Pods POST/v1/nexus/update-podupdate Pod
Method Endpoint Description POST/v1/nexus/add-provideradd Provider POST/v1/nexus/delete-providerdelete Provider GET/v1/nexus/get-global-providersget Global Providers GET/v1/nexus/get-providerget Provider GET/v1/nexus/get-providersget Providers POST/v1/nexus/refresh-mcp-toolsrefresh Mcp Tools POST/v1/nexus/update-providerupdate Provider
Method Endpoint Description POST/v1/nexus/add-recordadd Record POST/v1/nexus/add-recordsadd Records POST/v1/nexus/commit-recordcommit Record POST/v1/nexus/commit-record-secondcommit Record Second POST/v1/nexus/delete-recorddelete Record GET/v1/nexus/get-recordget Record GET/v1/nexus/get-recordsget Records GET/v1/nexus/query-recordquery Record GET/v1/nexus/query-record-secondquery Record Second POST/v1/nexus/update-recordupdate Record
Method Endpoint Description POST/v1/nexus/process-speech-to-textprocess Speech To Text
Method Endpoint Description GET/v1/nexus/get-storage-providersget Storage Providers
Method Endpoint Description POST/v1/nexus/add-storeadd Store POST/v1/nexus/delete-storedelete Store GET/v1/nexus/get-global-storesget Global Stores GET/v1/nexus/get-storeget Store GET/v1/nexus/get-storesget Stores POST/v1/nexus/refresh-store-vectorsrefresh Store Vectors POST/v1/nexus/update-storeupdate Store
Method Endpoint Description GET/v1/nexus/get-prometheus-infoget Prometheus Info GET/v1/nexus/get-system-infoget System Info GET/v1/nexus/get-version-infoget Version Info GET/healthhealth
Method Endpoint Description POST/v1/nexus/generate-text-to-speech-audiogenerate Text To Speech Audio GET/v1/nexus/generate-text-to-speech-audio-streamgenerate Text To Speech Audio Stream
Method Endpoint Description POST/v1/nexus/add-taskadd Task POST/v1/nexus/delete-taskdelete Task GET/v1/nexus/get-global-tasksget Global Tasks GET/v1/nexus/get-taskget Task GET/v1/nexus/get-tasksget Tasks POST/v1/nexus/update-taskupdate Task
Method Endpoint Description POST/v1/nexus/add-templateadd Template POST/v1/nexus/delete-templatedelete Template GET/v1/nexus/get-templateget Template GET/v1/nexus/get-templatesget Templates POST/v1/nexus/update-templateupdate Template
Method Endpoint Description GET/v1/nexus/get-range-usagesget Range Usages GET/v1/nexus/get-usagesget Usages GET/v1/nexus/get-usersget Users
Method Endpoint Description POST/v1/nexus/add-vectoradd Vector POST/v1/nexus/delete-all-vectorsdelete All Vectors POST/v1/nexus/delete-vectordelete Vector GET/v1/nexus/get-global-vectorsget Global Vectors GET/v1/nexus/get-vectorsget Vectors POST/v1/nexus/update-vectorupdate Vector
Method Endpoint Description POST/v1/nexus/add-videoadd Video POST/v1/nexus/delete-videodelete Video GET/v1/nexus/get-global-videosget Global Videos GET/v1/nexus/get-videoget Video GET/v1/nexus/get-videosget Videos POST/v1/nexus/update-videoupdate Video POST/v1/nexus/upload-videoupload Video
Method Endpoint Description POST/v1/nexus/add-workflowadd Workflow POST/v1/nexus/delete-workflowdelete Workflow GET/v1/nexus/get-global-workflowsget Global Workflows GET/v1/nexus/get-workflowget Workflow GET/v1/nexus/get-workflowsget Workflows POST/v1/nexus/update-workflowupdate Workflow
Hanzo Nexus API guide · All Hanzo APIs · OpenAPI spec
How is this guide?