Getting started

Platform API

With the API, your systems can read the TVs, files and playlists in your account without opening the control panel. Use it to show TV status in your own monitoring, check what is playing on each screen or build reports.

Each key sees exactly what its user sees in the control panel: the same organizations and, in each organization, whatever that user's permissions allow them to list.

Response format

• Responses are JSON (UTF-8). A single item comes in data; lists also include meta, with the pagination.
• Dates use ISO 8601 with the time zone, such as 2026-11-03T14:32:10-03:00.
• Every item has a uid, the same one used in the control panel. Use it to fetch the item later.
• A field with no value comes as null. New fields may be added at any time, so ignore the ones you don't recognize.

Start here

1. 1Authentication: generate a key in My Account › API and send it in the X-API-Key header.
2. 2Your user: make your first request to test the key.
3. 3What each user can see: see which organizations and items the key can read.

curl "https://api.on-cloud.live/v1/me" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/me');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['X-API-Key: ' . getenv('API_KEY')],
]);
$response = json_decode(curl_exec($ch), true);

const res = await fetch('https://api.on-cloud.live/v1/me', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data } = await res.json();

{
  "data": {
    "uid": "3c59dc048e8850243be8079a5c74d079",
    "name": "Mariana Souza",
    "email": "mariana@exemplo.com.br",
    "language": "pt_BR",
    "api_key": {
      "name": "Monitoramento",
      "prefix": "apk_527d541b",
      "created_at": "2026-11-01T09:15:42-03:00",
      "last_used_at": "2026-11-03T14:31:58-03:00"
    }
  }
}