Skip to main content
Layarva exposes a workspace-scoped Platform management API at https://api.layarva.com, alongside the separate Queue, Structured Widget and prayer-schedule integrations.

Platform / Workspace API

Manage Library folders/uploads, Playlists and Ready versions, Channels, Locations, Publications, Screen pairing and lifecycle, and Schedules from your backend.

Queue API

Read Queue services and state, issue tickets, and read a ticket using a Queue-scoped credential.

Prayer schedule Push

Push complete monthly prayer schedules using a workspace-scoped credential.

Widget API

Replace supported Widget snapshots without republishing the Design.

Widget WebSocket protocol

Stream compatible runtime envelopes from a relay that you operate.

Queue webhooks

Receive signed ticket-completed and ticket-no-show events from Layarva.

Platform webhooks

Receive signed API operation, upload, Playlist, Publication and offline-export events.
The Platform API supports the documented management resources, not account/member/billing management, Studio Design authoring, Campaign management or human approval review. PDF upload stores a document, not a playable Playlist item. A Ready version or completed Publication does not prove playback on a physical Screen. If a feature returns 503, stop that workflow and retry later when instructed, or contact support with its requestId. Queue webhooks remain separate.

Authentication boundaries

  • Queue API credentials are scoped to a Queue Unit and authorized Queue operations.
  • Platform / Workspace keys are unique to one workspace and use server-to-server Bearer authentication for management. They are separate from Studio Element / Widget keys and cannot authorize another workspace.
  • Widget API keys authorize the supported prayer-schedule and Structured Widget Push APIs. Find them in the Widget API Key tab in Settings.
  • Secure WebSocket connects a Player to your relay. It does not use the Platform or Widget API Key.
Custom HTML/JavaScript Widget guides remain excluded. Structured built-in Widgets use a separate, supported data contract documented here.

Start here