Skip to main content
Use the Platform API to manage Library assets and folders, Playlists, Channels, Locations, Edges, Screens, publication and Schedules.

Start in three steps

  1. Open Settings → API Keys → Workspace / Platform API Key in Layarva.
  2. Create a key with the permissions your integration needs.
  3. Use the key in Postman or your backend with the header below.
Your base URL is:
Find your workspace ID in the Layarva dashboard URL, after /app/.

Which API should I use?

These credentials are different and cannot replace one another.

What you need to send

  • GET: your Platform key. No request body or Idempotency-Key is needed.
  • POST, PATCH and DELETE: your Platform key plus an Idempotency-Key, a unique operation ID that prevents duplicate changes when you retry.
  • For JSON requests, set Content-Type: application/json.
See the quickstart or learn how to generate an Idempotency-Key.

Keep your integration safe

Keep your API key private. Use Postman or a trusted backend, not public browser code. A key only works in its own workspace and only for its selected permissions. Your workspace quotas and publishing rules still apply. Revoke a key immediately if it is exposed. Choose a limited expiry where practical, and rotate long-lived keys regularly.

Current availability

Uploads support PNG, JPEG, WebP, GIF, AVIF, self-contained Lottie JSON, PCM WAV, MP3, MP4 and PDF. PDF is stored in Documents and cannot be played as a Playlist item. You can also export eligible published content as an offline package and subscribe your backend to signed Platform webhooks.
If one of these features returns 503, stop that workflow and retry later when instructed, or contact support with its requestId. Do not repeatedly create jobs or poll an unavailable feature.
This API does not manage billing, workspace members or Studio Design authoring. Publication approval remains a human action in Layarva. Platform event webhooks notify your backend about API changes and asynchronous results. Queue webhooks are a separate integration with a different signature format.

Responses and retries

Successful responses contain data. Collection responses also contain page.nextCursor; use it as after to read the next page. For retries of a change, keep the same request body and Idempotency-Key. Do not repeatedly retry an invalid request. Include the response requestId when contacting support, but never send your API key.