Skip to content
openlaunch
Esc
↑↓navigate↵open⌘Jpreview

List visible devices

Owner receives workspace devices. Agent receives only devices covered by current grants, with grant-filtered capabilities.

GET/v1/devices
Authorization
AuthorizationBearer token (Clerk owner session) · headerrequired

Owner identity required.

or
AuthorizationBearer token (ol_agent token) · headerrequired

Owner-issued agent API connection; access ceiling and live device grants are checked separately.

or
AuthorizationBearer token (OAuth access token) · headerrequired

OAuth read/act scope is a ceiling. Scopes do not create device grants.

Responses
200

Successful response

dataDevice[]required
Show properties
Array of Device
idstring<uuid>required
namestringrequired
kindstringrequired
capabilitiesstring[]required
functionsFunctionDefinition[]
Show properties
Array of FunctionDefinition
namestringrequired
min length 1 · max length 64 · matches ^[a-z][a-z0-9_]*(?:\.[a-z][a-z0-9_]*)*$
titlestringrequired
min length 1 · max length 64
descriptionstringrequired
min length 1 · max length 240
accessstringrequired
Allowed:readwrite
inputSchemaobjectrequired
Show properties
typestringrequired
propertiesobjectrequired
requiredstring[]required
max items 16
additionalPropertiesbooleanrequired
lastSeenintegerrequired
revokedbooleanrequired
onlinebooleanrequired
400

Invalid request or validation failure

errorobjectrequired
Show properties
codestringrequired
messagestring
issuesobject[]
Show properties
Array of object
pathstring
messagestring
401

Missing or invalid credential

errorobjectrequired
Show properties
codestringrequired
messagestring
issuesobject[]
Show properties
Array of object
pathstring
messagestring
403

Insufficient access or grant

errorobjectrequired
Show properties
codestringrequired
messagestring
issuesobject[]
Show properties
Array of object
pathstring
messagestring
404

Resource not found

errorobjectrequired
Show properties
codestringrequired
messagestring
issuesobject[]
Show properties
Array of object
pathstring
messagestring
413

Request body exceeds the 16 KiB limit

errorobjectrequired
Show properties
codestringrequired
messagestring
issuesobject[]
Show properties
Array of object
pathstring
messagestring
429

Rate limit or workspace capacity limit

errorobjectrequired
Show properties
codestringrequired
messagestring
issuesobject[]
Show properties
Array of object
pathstring
messagestring
500

Internal error

errorobjectrequired
Show properties
codestringrequired
messagestring
issuesobject[]
Show properties
Array of object
pathstring
messagestring
503

Service or required integration is not configured

errorobjectrequired
Show properties
codestringrequired
messagestring
issuesobject[]
Show properties
Array of object
pathstring
messagestring
Try it
Server
Authorization
Request
ol devices list
Response
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "kind": "string",
      "capabilities": [
        "string"
      ],
      "functions": [
        {
          "name": "string",
          "title": "string",
          "description": "string",
          "access": "read",
          "inputSchema": {
            "type": "object",
            "properties": {
              "property1": {
                "type": "string",
                "description": "string",
                "minLength": 0,
                "maxLength": 0,
                "enum": [
                  "string"
                ]
              },
              "property2": {
                "type": "string",
                "description": "string",
                "minLength": 0,
                "maxLength": 0,
                "enum": [
                  "string"
                ]
              }
            },
            "required": [
              "string"
            ],
            "additionalProperties": false
          }
        }
      ],
      "lastSeen": 0,
      "revoked": true,
      "online": true
    }
  ]
}