Robots Management

APIs for listing and retrieving details about robots.

---

List Robots

Cloud

Retrieves all robots in the organization along with their online status.

Endpoint

GET /robots

Request Headers

{
  "authorization": "bearer <access_token>"
}

Response Example

{
  "robotDataList": [
    {
      "basicData": { "id": "11111111-2122-1122-2233-555555319861", "name": "AMR-01" },
      "isOnline": true
    },
    {
      "basicData": { "id": "11111111-2122-1122-2233-555555319862", "name": "AMR-02" },
      "isOnline": false
    }
  ]
}

Local

Returns the current local robot and, when configured, local-fleet member robots.

Endpoint

GET /robots

Request Headers

{
  "authorization": "bearer <local-api-gateway-token>"
}

Response Example

{
  "robotDataList": [
    {
      "basicData": { "id": "robot-1", "name": "local-bot" },
      "isOnline": true
    },
    {
      "basicData": { "id": "fleet-robot-1", "name": "fleet-bot" },
      "isOnline": true
    }
  ]
}

The current local robot is returned first. Configured local-fleet members follow it with their current probed online state.

The older singular route, GET /robot, remains available as a compatibility alias.

---

Get Robot Details

Cloud

Retrieves full details for a specific robot by its ID.

Endpoint

GET /robots/{robotId}

Request Headers

{
  "authorization": "bearer <access_token>"
}

Path Parameters

• robotId (string): The unique identifier of the robot.

Response Fields

Field	Type	Description
robotData	object	Basic robot data and online status
fleetName	string	Name of the fleet the robot belongs to
organizationName	string	Name of the organization
lastTimeSeen	datetime	Last time the robot was online (UTC)
members	object	Organization admins and shared users with permissions
configurationInformation	object	Active configuration name and version
agentVersion	string	Current agent version running on the robot
latestAgentVersion	string	Latest available agent version

Response Example

{
  "robotData": {
    "basicData": {
      "id": "11111111-2122-1122-2233-555555319864",
      "name": "AMR-Qualcomm-RB5"
    },
    "isOnline": false
  },
  "fleetName": "Warehouse-Floor-A",
  "organizationName": "Cogniteam",
  "lastTimeSeen": "2024-09-29T13:07:27.211444Z",
  "members": {
    "orgAdmins": {
      "orgAdmins": ["admin@cogniteam.com"]
    },
    "sharedUsers": {
      "userPermissions": [
        { "userId": "user@cogniteam.com", "permissionType": 1 }
      ]
    }
  },
  "configurationInformation": {
    "name": "default-config",
    "version": "1.0.8"
  },
  "agentVersion": "5.4.0.17",
  "latestAgentVersion": "5.4.0.19"
}

note

lastTimeSeen returns "0001-01-01T00:00:00Z" when the robot has never connected to the platform.

User Permission Types

Value	Role
0	None
1	Operator
2	Developer
3	Admin

Local

Returns details for the local robot or proxies the request to a configured local-fleet member.

Endpoint

GET /robots/{robotId}

Request Headers

{
  "authorization": "bearer <local-api-gateway-token>"
}

Path Parameters

• robotId (string): The ID of the local robot or a configured local-fleet member.

Response Example

{
  "robotData": {
    "basicData": { "id": "robot-1", "name": "local-bot" },
    "isOnline": true
  },
  "fleetName": "Local",
  "organizationName": "Cogniteam",
  "lastTimeSeen": "2026-06-22T09:00:00Z",
  "members": {
    "orgAdmins": { "orgAdmins": [] },
    "sharedUsers": {
      "userPermissions": [
        { "userId": "user@cogniteam.com", "permissionType": 0 }
      ]
    }
  },
  "configurationInformation": { "name": "", "version": "" },
  "agentVersion": "",
  "latestAgentVersion": ""
}

The Local API currently returns empty configuration and agent-version fields for the local robot. They remain in the response so its schema matches the Cloud API.

Local-Fleet Behavior

• Normal robot-scoped REST routes can be proxied to configured local-fleet member agents.
• The proxy logs in to the member agent with the stored local-fleet password.
• The proxy forwards the original method, path, query string, body, and non-hop headers.
• Live WebSocket stream requests are not proxied. They return 501 when the selected robot is a local-fleet member.
• The older singular /robot/{robotId} route remains available as a compatibility alias.

Common Errors

Code	Reason
401	Bearer token missing or invalid
404	Robot ID is not the local robot and not a configured local-fleet member
501	Live WebSocket stream tunneling to a local-fleet member is not implemented