Skip to main content

API Docs Introduction

🚀 Welcome to the HiveonAI API Documentation!​

This comprehensive guide is designed for vendors looking to seamlessly bridge the gap between devices and machines. Whether you are a host managing multiple machines or a vendor eager to leverage our services, you'll find all the essential information right here.

⚠️ Early Alpha Version Notice​

Please note that this API is in an early alpha version and is subject to changes. We appreciate your understanding as we work to improve and stabilize our services.

📚 What You Will Find Inside​

Glossary 📖​

Understand key terms such as Machine, Host, and Deployment to get familiar with our terminology.

API Endpoints 🌐​

  • List Available Machines: Discover how to retrieve machines that are ready for your tasks.
  • Status Documentation: Get to grips with the various statuses your machines and deployments can have, including operational and task statuses, to efficiently monitor and manage your resources.

💡 Getting Started​

🔍 Explore our API​

Dive into detailed descriptions of each endpoint, complete with request and response examples, to fully leverage the capabilities of our API.

🔧 Troubleshooting and Support​

Encounter an issue? Check out our troubleshooting guide or reach out for support at [email protected].

Happy Coding! 🎉