# InOrbit Docs

> Documentation for InOrbit's robot operations platform

## Docs

- [Executes an action on a robot](https://inorbitinc.mintlify.app/api-reference/actions/executes-an-action-on-a-robot.md): Executes an action on a robot
- [Queries the status of an action execution reported by a robot](https://inorbitinc.mintlify.app/api-reference/actions/queries-the-status-of-an-action-execution-reported-by-a-robot.md): Queries the status of an action execution for a robot
- [Returns the list of all actions defined for a robot](https://inorbitinc.mintlify.app/api-reference/actions/returns-the-list-of-all-actions-defined-for-a-robot.md): Returns the list of all actions defined for a robot
- [Returns a list with the values for a selected attribute](https://inorbitinc.mintlify.app/api-reference/attributes/returns-a-list-with-the-values-for-a-selected-attribute.md): Returns a list with the values for a selected attribute
- [Returns all attribute definitions](https://inorbitinc.mintlify.app/api-reference/attributes/returns-all-attribute-definitions.md): Returns all attribute definitions
- [Returns all attribute definitions for a robot](https://inorbitinc.mintlify.app/api-reference/attributes/returns-all-attribute-definitions-for-a-robot.md): Returns all attribute definitions for a robot. They are normally the same as the attribute definitions for the account it belongs to, except the case when configuration overrides have been defined for the robot.
- [Returns an attribute definition](https://inorbitinc.mintlify.app/api-reference/attributes/returns-an-attribute-definition.md): Returns an attribute definition
- [Returns an attribute definition from a specific robot](https://inorbitinc.mintlify.app/api-reference/attributes/returns-an-attribute-definition-from-a-specific-robot.md): Returns an attribute definition from a specific robot. Note that these are normally the same definitions from the account it belongs to; unless it has specific configuration overrides.
- [Returns an attribute last value and last update time](https://inorbitinc.mintlify.app/api-reference/attributes/returns-an-attribute-last-value-and-last-update-time.md): Returns an attribute last value and the timestamp of the last update
- [Returns a list of robot logged events](https://inorbitinc.mintlify.app/api-reference/auditlogs/returns-a-list-of-robot-logged-events.md): Returns a list of robot logged events
- [List camera images for a camera and time range](https://inorbitinc.mintlify.app/api-reference/cameraimages/list-camera-images-for-a-camera-and-time-range.md): Returns a list of camera images for the specified camera and time range. For each image, the response includes the timestamp and a URL that can be used to download the image. These URLs are already signed, so no extra authentication is required.
- [Creates a new collection](https://inorbitinc.mintlify.app/api-reference/collections/creates-a-new-collection.md)
- [Creates a new tag for a collection](https://inorbitinc.mintlify.app/api-reference/collections/creates-a-new-tag-for-a-collection.md)
- [Deletes a collection](https://inorbitinc.mintlify.app/api-reference/collections/deletes-a-collection.md)
- [Deletes a tag](https://inorbitinc.mintlify.app/api-reference/collections/deletes-a-tag.md)
- [Returns a collection](https://inorbitinc.mintlify.app/api-reference/collections/returns-a-collection.md): Returns a collection
- [Returns a tag](https://inorbitinc.mintlify.app/api-reference/collections/returns-a-tag.md): Returns a tag.
- [Returns the list of all collections](https://inorbitinc.mintlify.app/api-reference/collections/returns-the-list-of-all-collections.md): Returns the list of all collections Note that only collections visible to the user are included in the result.
- [Returns the list of tags](https://inorbitinc.mintlify.app/api-reference/collections/returns-the-list-of-tags.md): Returns the list of tags defined in the account. Note that only tags visible to the user are included in the result.
- [Returns the list of tags for a collection](https://inorbitinc.mintlify.app/api-reference/collections/returns-the-list-of-tags-for-a-collection.md): Returns the list of tags for a collection. Only tags visible to the user are included in the result. Note that this is equivalent to the endpoint /tags?collectionId=xx
- [Updates a collection](https://inorbitinc.mintlify.app/api-reference/collections/updates-a-collection.md)
- [Updates a tag](https://inorbitinc.mintlify.app/api-reference/collections/updates-a-tag.md)
- [Applies a configuration object](https://inorbitinc.mintlify.app/api-reference/configapi/applies-a-configuration-object.md)
- [Clears a configuration object at a specific scope](https://inorbitinc.mintlify.app/api-reference/configapi/clears-a-configuration-object-at-a-specific-scope.md)
- [Retrieves a list of configuration objects](https://inorbitinc.mintlify.app/api-reference/configapi/retrieves-a-list-of-configuration-objects.md)
- [Retrieves the list of kinds](https://inorbitinc.mintlify.app/api-reference/configapi/retrieves-the-list-of-kinds.md)
- [Evaluates an expression](https://inorbitinc.mintlify.app/api-reference/expressions/evaluates-an-expression.md)
- [Closes an incident related to a robot](https://inorbitinc.mintlify.app/api-reference/incidents/closes-an-incident-related-to-a-robot.md): Closes an incident related to a robot
- [Opens an incident related to a robot](https://inorbitinc.mintlify.app/api-reference/incidents/opens-an-incident-related-to-a-robot.md): Opens an incident related to a robot using the provided alias as key.
- [Generates a robot key](https://inorbitinc.mintlify.app/api-reference/inorbitconnect/generates-a-robot-key.md): ![Beta](Status-Beta-yellow.svg)
- [Generates InOrbit Connect activation codes](https://inorbitinc.mintlify.app/api-reference/inorbitconnect/generates-inorbit-connect-activation-codes.md): ![Beta](Status-Beta-yellow.svg)
- [Sets InOrbit Connect model for robot](https://inorbitinc.mintlify.app/api-reference/inorbitconnect/sets-inorbit-connect-model-for-robot.md): ![Beta](Status-Beta-yellow.svg)
- [Aggregate KPI objects](https://inorbitinc.mintlify.app/api-reference/kpis/aggregate-kpi-objects.md): Calculates aggregations over KPI objects within a time range.
- [List KPI objects](https://inorbitinc.mintlify.app/api-reference/kpis/list-kpi-objects.md): Lists KPI objects with filtering and pagination support. All fields can be filtered.
- [Downloads a map binary image](https://inorbitinc.mintlify.app/api-reference/localization/downloads-a-map-binary-image.md): Retrieves the raw map image from a robot, given its id. The resulting image is always in PNG format, with `Content-Type: image/png`. To use this map, the metadata from /{mapId} API is also necessary (resolution, origin).
- [Retrieves a list of maps available for a robot](https://inorbitinc.mintlify.app/api-reference/localization/retrieves-a-list-of-maps-available-for-a-robot.md): Returns a list of maps available for the requested robot
- [Retrieves a robot's map metadata given is id
](https://inorbitinc.mintlify.app/api-reference/localization/retrieves-a-robots-map-metadata-given-is-id.md): Retrieves an individual map's metadata or binary data. By default, a map metadata including size, resolution, last updated timestamp and other fields is returned in JSON format (see `application/json` response). By specifying `Accept: image/png` the map in binary image form can be retrieved. See als…
- [Retrieves the robot's current map metadata
](https://inorbitinc.mintlify.app/api-reference/localization/retrieves-the-robots-current-map-metadata.md): Retrieves the map metadata for the robot's current map. By default, a map metadata including size, resolution, last updated timestamp and other fields is returned in JSON format.
- [Returns a robot's current pose](https://inorbitinc.mintlify.app/api-reference/localization/returns-a-robots-current-pose.md): Returns the pose of a robot, including position and orientation
- [Returns all available localization data for a robot](https://inorbitinc.mintlify.app/api-reference/localization/returns-all-available-localization-data-for-a-robot.md): Returns all available localization data for a robot, including pose and lasers if available.  If an `include` query param is sent, only those values are returned.
- [Upload map data](https://inorbitinc.mintlify.app/api-reference/localization/upload-map-data.md): ![Beta](Status-Beta-yellow.svg)
- [checks if a robot is locked](https://inorbitinc.mintlify.app/api-reference/locks/checks-if-a-robot-is-locked.md): Checks if a robot is locked
- [locks a robot](https://inorbitinc.mintlify.app/api-reference/locks/locks-a-robot.md): Locks a robot
- [unlocks a robot](https://inorbitinc.mintlify.app/api-reference/locks/unlocks-a-robot.md): Locks a robot
- [Aborts a running a mission](https://inorbitinc.mintlify.app/api-reference/missions/aborts-a-running-a-mission.md): Cancels currently running mission given its id.
- [Dispatches a mission for execution](https://inorbitinc.mintlify.app/api-reference/missions/dispatches-a-mission-for-execution.md): Dispatches a mission for execution. It can use a previously-defined mission [(see Mission Definition)](https://docs.inorbit.ai/ground-control/configuration/kinds/mission-definitions), identified by `missionDefinitionId` or a one-off mission definition provided in the dispatch API call.
- [Pauses or resumes a mission execution](https://inorbitinc.mintlify.app/api-reference/missions/pauses-or-resumes-a-mission-execution.md): Modifies a mission execution. Currently, only pausing and resuming executions are supported. (To abort a mission, see `abortMission` API)
- [Creates a mission](https://inorbitinc.mintlify.app/api-reference/missiontracking/creates-a-mission.md): Creates a mission for the robot. It returns the mission information in the response
- [Queries missions](https://inorbitinc.mintlify.app/api-reference/missiontracking/queries-missions.md): Returns a list of missions that satisfy some filters
- [Retrieves a mission](https://inorbitinc.mintlify.app/api-reference/missiontracking/retrieves-a-mission.md): Returns information about a mission
- [Terminates a mission](https://inorbitinc.mintlify.app/api-reference/missiontracking/terminates-a-mission.md): Communicates that the current mission has been cancelled. It is equivalent to PUT on the same path, with   { status: cancelled }. Note: Does NOT actually delete a mission.
- [Updates a mission](https://inorbitinc.mintlify.app/api-reference/missiontracking/updates-a-mission.md): Communicates updates on a mission execution. It should be called whenever a mission status changes (has started, has finished) or any of its tasks has just been completed. Times are recorded assuming these updates are called immediately.
- [Sends a list of waypoints to a robot](https://inorbitinc.mintlify.app/api-reference/navigation/sends-a-list-of-waypoints-to-a-robot.md): ![Beta](Status-Beta-yellow.svg) Sends a list of navigation waypoints to a robot
- [Retrieves a list of robots](https://inorbitinc.mintlify.app/api-reference/robots/retrieves-a-list-of-robots.md): Returns information about all robots this account can access
- [Retrieves a robot](https://inorbitinc.mintlify.app/api-reference/robots/retrieves-a-robot.md): Returns information about a robot given its id
- [Returns the list of tags for a robot](https://inorbitinc.mintlify.app/api-reference/robots/returns-the-list-of-tags-for-a-robot.md): Returns the list of tags applied to a robot
- [Tags a robot](https://inorbitinc.mintlify.app/api-reference/robots/tags-a-robot.md)
- [Untag a robot](https://inorbitinc.mintlify.app/api-reference/robots/untag-a-robot.md)
- [Retrieves a list of areas within a location.](https://inorbitinc.mintlify.app/api-reference/spaces/retrieves-a-list-of-areas-within-a-location.md): Returns information about all areas within the specified location.
- [Retrieves information about a specific area.](https://inorbitinc.mintlify.app/api-reference/spaces/retrieves-information-about-a-specific-area.md): Returns information about a specific area within the specified location.
- [Lists the zones in a location](https://inorbitinc.mintlify.app/api-reference/trafficmanagement/lists-the-zones-in-a-location.md): Lists the zones in a location. Allows filtering by area using the `frameId` query parameter.
- [Retrieves a zone's user-defined data](https://inorbitinc.mintlify.app/api-reference/trafficmanagement/retrieves-a-zones-user-defined-data.md): Retrieves and returns any user-defined data appended to this Traffic Zone.
- [Retrieves the zone properties; including its state.](https://inorbitinc.mintlify.app/api-reference/trafficmanagement/retrieves-the-zone-properties;-including-its-state.md): Retrieves the zone properties, as assigned by a traffic controller. For example its state and robots currently inside the zone.
- [Updates a Traffic Zone user-defined data](https://inorbitinc.mintlify.app/api-reference/trafficmanagement/updates-a-traffic-zone-user-defined-data.md): Assigns user-defined data to a Traffic Zone. This data is an arbitrary key-value dictionary, which will be added to the Zone, overwriting existing data with the same keys. Null values will clear (delete) existing keys.
- [Updates the zone properties; including its state.](https://inorbitinc.mintlify.app/api-reference/trafficmanagement/updates-the-zone-properties;-including-its-state.md): Modifies zones properties. It currently allows changing the zone "state", which determines the zone visual representation in the app. (For example if there are `conditionalStyle` treatments in its Zone Type). Beware that normally traffic controllers change the `state` (and other properties), so this…
- [Connect](https://inorbitinc.mintlify.app/connect/index.md): Ecosystem of hardware partners and integrations
- [REST APIs](https://inorbitinc.mintlify.app/ground-control/application-integration/rest-apis.md): RESTful APIs for integrating robot functionality
- [Authentication](https://inorbitinc.mintlify.app/ground-control/authentication.md): API keys and authentication for InOrbit APIs and SDKs
- [Expressions Language](https://inorbitinc.mintlify.app/ground-control/concepts/expressions-language.md): JavaScript-like language for conditions and calculations
- [Maps](https://inorbitinc.mintlify.app/ground-control/concepts/maps.md): Spatial representation and navigation
- [InOrbit CLI](https://inorbitinc.mintlify.app/ground-control/configuration/cli.md): Command-line interface for managing configurations
- [Action Definitions](https://inorbitinc.mintlify.app/ground-control/configuration/kinds/action-definitions.md): Configure commands that operators can trigger on robots
- [Dashboards](https://inorbitinc.mintlify.app/ground-control/configuration/kinds/dashboards.md): Build custom monitoring interfaces with widgets and layouts
- [Data Sources](https://inorbitinc.mintlify.app/ground-control/configuration/kinds/data-sources.md): Define how robot data is captured and transformed into queryable attributes
- [Incident Definitions](https://inorbitinc.mintlify.app/ground-control/configuration/kinds/incident-definitions.md): Configure when incidents are created and how operators are notified
- [Configuration Kinds](https://inorbitinc.mintlify.app/ground-control/configuration/kinds/index.md): Reference documentation for all configuration object types in InOrbit
- [KPI Definitions](https://inorbitinc.mintlify.app/ground-control/configuration/kinds/kpi-definitions.md): Aggregate fleet metrics for performance analysis and reporting
- [Mission Definitions](https://inorbitinc.mintlify.app/ground-control/configuration/kinds/mission-definitions.md): Define missions for your robot fleet and configure their execution
- [Mission Tracking](https://inorbitinc.mintlify.app/ground-control/configuration/kinds/mission-tracking.md): Configure how mission progress and performance are monitored
- [Preferences](https://inorbitinc.mintlify.app/ground-control/configuration/kinds/preferences.md): Configure UI defaults and widget behavior settings
- [Robot Camera](https://inorbitinc.mintlify.app/ground-control/configuration/kinds/robot-camera.md): Configure camera feeds displayed in the InOrbit interface
- [Robot Footprint](https://inorbitinc.mintlify.app/ground-control/configuration/kinds/robot-footprint.md): Configure the visual footprint representing a robot's occupied area on maps
- [Spatial Annotations](https://inorbitinc.mintlify.app/ground-control/configuration/kinds/spatial-annotations.md): Define map elements such as waypoints that missions can reference
- [Status Definitions](https://inorbitinc.mintlify.app/ground-control/configuration/kinds/status-definitions.md): Define rules to flag robot health issues based on data source values
- [Traffic Management](https://inorbitinc.mintlify.app/ground-control/configuration/kinds/traffic-management.md): Control where and how robots navigate with traffic zones and rules
- [Configuration Overview](https://inorbitinc.mintlify.app/ground-control/configuration/overview.md): Introduction to InOrbit configuration management
- [Ground Control](https://inorbitinc.mintlify.app/ground-control/index.md): Developer tools and SDKs for robot integration
- [InOrbit Agent](https://inorbitinc.mintlify.app/ground-control/robot-integration/agent.md): Connect ROS robots with the InOrbit Agent
- [Configuration](https://inorbitinc.mintlify.app/ground-control/robot-integration/connector-framework/configuration.md): Configuration models and file formats for connectors
- [Getting Started](https://inorbitinc.mintlify.app/ground-control/robot-integration/connector-framework/getting-started.md): Installation and setup for the InOrbit Connector Framework
- [Connector Framework](https://inorbitinc.mintlify.app/ground-control/robot-integration/connector-framework/index.md): Python framework for developing InOrbit robot connectors
- [Publishing Data](https://inorbitinc.mintlify.app/ground-control/robot-integration/connector-framework/publishing.md): How to publish robot data to InOrbit
- [Commands Utilities](https://inorbitinc.mintlify.app/ground-control/robot-integration/connector-framework/specification/commands.md): Command handling utilities specification
- [Connector API](https://inorbitinc.mintlify.app/ground-control/robot-integration/connector-framework/specification/connector.md): Connector and FleetConnector class specifications
- [Specification](https://inorbitinc.mintlify.app/ground-control/robot-integration/connector-framework/specification/index.md): Public API specification for the inorbit-connector package
- [Logging](https://inorbitinc.mintlify.app/ground-control/robot-integration/connector-framework/specification/logging.md): Logging configuration specification
- [Models](https://inorbitinc.mintlify.app/ground-control/robot-integration/connector-framework/specification/models.md)
- [Utilities](https://inorbitinc.mintlify.app/ground-control/robot-integration/connector-framework/specification/utils.md): Utility functions specification
- [Commands Handling](https://inorbitinc.mintlify.app/ground-control/robot-integration/connector-framework/usage/commands-handling.md): How to handle commands from InOrbit
- [Fleet Connector](https://inorbitinc.mintlify.app/ground-control/robot-integration/connector-framework/usage/fleet.md): Guide for implementing a fleet connector
- [Usage](https://inorbitinc.mintlify.app/ground-control/robot-integration/connector-framework/usage/index.md): Guides for implementing connectors
- [Single-Robot Connector](https://inorbitinc.mintlify.app/ground-control/robot-integration/connector-framework/usage/single-robot.md): Guide for implementing a single-robot connector
- [Connectors](https://inorbitinc.mintlify.app/ground-control/robot-integration/connectors.md): Pre-built integrations for popular robot platforms and fleet managers
- [Edge SDK](https://inorbitinc.mintlify.app/ground-control/robot-integration/edge-sdk.md): SDK for connecting robots from intermediary applications
- [Interoperability Standards](https://inorbitinc.mintlify.app/ground-control/robot-integration/interoperability.md): Support for industry standards and protocols
- [Connect Robots](https://inorbitinc.mintlify.app/ground-control/robot-integration/overview.md): Options for connecting robots to InOrbit
- [Robot SDK](https://inorbitinc.mintlify.app/ground-control/robot-integration/robot-sdk.md): SDK for bidirectional robot-to-cloud communication
- [InOrbit Docs](https://inorbitinc.mintlify.app/index.md)
- [OpenRobOps](https://inorbitinc.mintlify.app/openrobops/index.md): Open source fleet management platform
- [Business Execution System](https://inorbitinc.mintlify.app/space-intelligence/business-execution/bes.md): Translate business orders into optimized robot missions
- [RobOps Copilot](https://inorbitinc.mintlify.app/space-intelligence/business-execution/copilot.md): AI-powered conversational interface for robot operations
- [Space Intelligence](https://inorbitinc.mintlify.app/space-intelligence/index.md): AI-powered robot operations platform for enterprise facilities

## OpenAPI Specs

- [inorbit.openapi](https://inorbitinc.mintlify.app/inorbit.openapi.json)
- [openapi](https://inorbitinc.mintlify.app/api-reference/openapi.json)