Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

The control surface credential. Send Authorization: Bearer <token>.

Two kinds of token are accepted and they are told apart by shape, not by a separate header. A token beginning pbk_ or puk_ is an org scoped API key, whose public half and secret half are generated together and of which only a hash of the secret is ever stored; anything else is treated as an OAuth 2.1 access token and verified against the authorization server's keys.

Both resolve to the same context: an org, a principal and a set of scopes. Nothing downstream branches on which channel you used, with one deliberate exception, key management, which requires a signed-in person so that a key can never mint another key.

Scopes are enforced when MCP tools are REGISTERED rather than when they are called, so a tool your credential cannot use is absent from tools/list rather than refused mid gesture.

Query Parameters

ids
string[]
required

The devices to picture, by deviceId: one id per parameter, repeated (ids=a&ids=b), so an id may contain any character a listing returns, commas included. At most 24.

Required array length: 1 - 24 elements
Minimum string length: 1
have
string[]

Pictures you already hold: one deviceId:version per parameter, repeated. The version is what follows the last colon. A device whose picture has not changed answers without image. Entries that do not parse are ignored.

Response

One entry per requested id, in the order asked.

refreshAfterMs
integer
required

How long to wait before asking again, in milliseconds.

Required range: x >= 0
thumbnails
object[]
required