Skip to main content

Introduction

The Cogniteam Cloud Platform provides a robust RESTful API gateway, optimized for fleet-level monitoring and management of robotic systems.

While not designed for real-time operation, the API is perfect for retrieving metric data, accessing robot information, and monitoring sensory data streams from ROS and ROS2 environments. It also supports sending commands and accessing fleet-wide data streams, offering comprehensive insights into robotic performance and behavior.

With built-in rate limits, the API ensures stable and efficient usage, making it an ideal tool for non-real-time applications such as fleet monitoring, status tracking, and operational oversight across diverse robotic deployments.

API Gateway V2 is the latest version of the Cogniteam Cloud Platform REST API. It replaces the Protobuf-based V1 interface with native JSON models, making integration simpler across any language or platform.

Base URL​

  • Global: https://api.cognimbus.com/apigateway/v2
  • Asia region: https://api.ap1.cognimbus.com/apigateway/v2

What's New in V2​

  • Native JSON request/response models (no Protobuf dependency)
  • Polymorphic metric types using JSON type discriminators
  • Stream upload support
  • Robot resource listing and pre-signed download URLs
  • Event log ingestion
  • Fleet Custom KPI WebSocket for live KPI updates across fleet members
  • Robot Live Events WebSocket for new event summaries

Authentication​

All endpoints (except /auth/login) require a Bearer token in the Authorization header. See Authentication for details.

Error Shape​

Failures return a standard HTTP status code with this JSON body:

{
"error": "Human-readable error message."
}

Common statuses:

  • 400: request fields or query parameters are missing or invalid, or a JSON body is missing or malformed.
  • 401: login failed, or the bearer token is missing, expired or invalid.
  • 404: the robot, fleet, metric, resource, stream, message type or task was not found, or is not accessible to the caller.
  • 405: the route exists but does not accept this HTTP method.
  • 409: the Agent refused a task command.
  • 503: the robot is offline or temporarily unreachable.
  • 504: the Agent did not reply before the command timeout.

The error text is for display. Use the status code to decide how to handle a failure.

note

This documentation is under active development.