Getting Started

Get access to HUVR

To start building with HUVR, you need a HUVR workspace, user credentials and service account for machine-to-machine integrations.

If you are building inspection robots or other hardware and want be part of the HUVR Partner Network connect with us here.

For existing customers that want to explore the API, contact your Customer Success representative for API credentials.

New users will want check out the HUVR Nomenclature guide to understand our terminology.

🔐 Authentication

Most requests require authentication, learn more: Authentication

Workspace Setup

For our customers, we work with them to build out their workspace as needed. Most API calls have dependencies that require this setup to be completed. For example, the workspace needs at least one workflow setup and a Company available for most workflows.

After the basic setup is complete, the asset data needs to be imported. Most customers have their asset data in some database or spreadsheet. HUVR allows the asset registry to be built from a variety of sources.

To get started, log into your workspace and create at least one demo asset to use with the API.

🧑‍💻 Detailed API Reference

See a full list of available API endpoints with code samples

A few to get started:

💬 We're here to help!

Head over to the Community tab and ask us a question