Before you start
Use the Postman setup:platform_base is https://api.layarva.com/api/platform/v1/workspaces/YOUR_WORKSPACE_ID, with your Platform key as the Bearer token.
For POST, PATCH and DELETE, use Body → raw → JSON, Content-Type: application/json and a new Idempotency-Key per new change. GET needs no body or operation key.
For the main workflow, select screens.read, screens.create, screens.pair, screens.update and screens.playback. Other actions have their own permissions listed below. Your plan limits apply; all assigned IDs must belong to the same workspace. Queue-managed Screens are protected.
Step 1: Choose the delivery mode
The steps below use CLOUD. Cloud pairing codes are not used to pair an Edge-served LAN display or an offline-package Screen.
Step 2: List or create the Screen record
List existing Screens with GET{{platform_base}}/screens?limit=25, or search with /screens?q=Lobby&limit=25.
To create an unpaired Cloud Screen, send POST {{platform_base}}/screens:
data.id as screen_id. Creating the record does not pair the physical Player.
Step 3: Pair the actual Cloud Player
- Open Layarva Player on the device you own.
- Read its current six-digit pairing code.
- Send POST
{{platform_base}}/screens/{{screen_id}}/pair:
pairing_code to the real code as a string, including leading zeroes. Do not generate a random number or use a code from another device. Keep it private. If it expires, obtain a fresh code from the Player; do not repeatedly retry the old code.
Alternative: create and pair in one request
If you have not already created a Screen record, send POST{{platform_base}}/screens/pair with screens.pair:
data.id. Choose either this one-request flow or the create-then-pair flow above; do not use both for the same device.
Step 4: Assign or change Channel and Location
Send PATCH{{platform_base}}/screens/{{screen_id}}:
name and clientId. Where permitted, null clears an assignment. Do not change delivery mode through PATCH; use the dedicated delivery endpoint below.
Optional: configure output size and fit
Include a completedisplayConfig in your create or PATCH request:
FIT, FILL, STRETCH, CUSTOM; anchors include CENTER and the eight edge/corner positions.
Step 5: Check connection and playback
Read GET{{platform_base}}/screens/{{screen_id}}. Check paired, status, lastPingAt and assignments. status represents current connectivity; do not use storedStatus as proof of a recent heartbeat.
Read GET {{platform_base}}/screens/{{screen_id}}/playback:
playbackEnabledshows whether playback is enabled.desiredPublicationIdis the expected release.activePublicationIdis the release reported active by the Player.stateandupdatedAthelp interpret the report. A new Screen may have no report yet.
Step 6: Enable playback or control audio
Send POST{{platform_base}}/screens/{{screen_id}}/playback:
false to disable playback. For audio, send POST /screens/{{screen_id}}/audio with {"videoMuted": false}; true mutes video audio. Both changes require screens.playback.
Other Screen actions
Use the same authenticated JSON setup and a new operation UUID for each new change.
Do not change
force to true simply to bypass a delivery conflict. Review the handover requirements first. This endpoint does not convert a Screen into offline-package mode. Unlock codes are not returned by reads; do not log them.
Deleting/archiving is not a remote wipe of a disconnected device. Offline lease revocation is enforced when the Player reconnects.
Filter and paginate Screen lists
Examples:/screens?channelId={{channel_id}}&limit=25, /screens?locationId={{location_id}}&status=ONLINE, or /screens?deliveryMode=EDGE&edgeDeviceId={{edge_id}}.
For more pages, send the returned page.nextCursor as after. Stop when it is null. See all supported filters.

