Skip to main content

Public API

The SolidPixels Public API lets you manage your account, release app versions, control devices, and push images from your own software.

Authentication​

All public API endpoints use Bearer authentication. Include your API key in the Authorization header of every request:

Authorization header
Authorization: Bearer <API key>
Keep your API key private

Create and revoke named keys in the SolidPixels app under Development Resources → API keys. A key is displayed only once when it is created, so copy it immediately and store it securely. You must own at least one device before you can create a key.

Your account​

GET/v1/account/

Return the email address and creation time for the authenticated account.

Request
GET /v1/account/
Authorization: Bearer <API key>
200 response
{
  "email": "[email protected]",
  "createdAt": "2025-01-15T12:30:00.000Z"
}

Explore the API​

  • Apps — discover available apps, submit immutable versions for review, and deploy or roll back an approved release.
  • Devices — list devices, inspect their state, update settings, and manage installations.
  • Push images — send a transient image to a device or create a persistent rotation entry.

Every list endpoint returns a bare JSON array. Unless an endpoint says otherwise, invalid bodies return 400, missing resources return 404, and requests without permission to access a resource return 403.

Was this helpful?