Skip to main content

Documentation Index

Fetch the complete documentation index at: https://inorbitinc.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

InOrbit offers REST and streaming APIs that enable programmatic access to InOrbit features. Using these APIs you can fetch data related to your robots, trigger actions, integrate with incident management systems and more.

Overview

The InOrbit REST API provides programmatic access to all major InOrbit features. All API endpoints are authenticated using app keys. See Authentication for details on obtaining and using your API keys.

Authentication

Learn how to authenticate API requests

API Reference

Browse all available API endpoints

Available API Categories

The REST API is organized into the following categories:
  • Robots - List and retrieve robot information
  • Collections & Tags - Operations on collections and tags
  • Attributes - Operations on attributes (data sources values)
  • Localization & Maps - Queries on robots localization and maps
  • Spaces - Queries and operations on spaces (Beta)
  • Navigation - Operations related to robots navigation
  • Locks - APIs to lock and unlock robots
  • Actions - Operations on robots actions
  • Incidents - Operations to open and close incidents
  • Missions - Mission execution and control
  • Mission Tracking - Track robot missions’ execution
  • Traffic Management - Retrieve and update Traffic Management & Zones information
  • KPIs - KPI queries
  • Expressions - Test and evaluate expressions
  • InOrbit Connect - Provisioning and management
  • Config API - Configuration management
  • Camera Images - Work with camera images
  • Audit Logs - Audit log queries

Getting Started

All API requests should be made to https://api.inorbit.ai and include your app key in the x-auth-inorbit-app-key header. For detailed endpoint documentation, see the API Reference section below.