> ## Documentation Index
> Fetch the complete documentation index at: https://docs.layarva.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Platform / Workspace API

> Manage your workspace through the Layarva API.

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.

```http theme={null}
Authorization: Bearer YOUR_PLATFORM_API_KEY
```

Your base URL is:

```text theme={null}
https://api.layarva.com/api/platform/v1/workspaces/YOUR_WORKSPACE_ID
```

Find your workspace ID in the Layarva dashboard URL, after `/app/`.

## Which API should I use?

| API | Purpose | Key |
| - | - | - |
| Platform / Workspace API | Manage signage resources in your workspace | Workspace / Platform API Key |
| [Widget API](https://docs.layarva.com/developers/widget-api.md) | Send data to Studio elements and supported Widgets | Widget API Key |
| [Queue API](https://docs.layarva.com/developers/queue-api.md) | Manage Queue tickets and services | Queue credential |

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](https://docs.layarva.com/developers/platform-quickstart.md) or [learn how to generate an Idempotency-Key](https://docs.layarva.com/developers/platform-request-keys.md).

## 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.

> [!NOTE]
>
> 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](https://docs.layarva.com/developers/platform-webhooks.md) notify your backend about API changes and asynchronous results. [Queue webhooks](https://docs.layarva.com/developers/webhooks.md) 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.

| Status | What to do |
| - | - |
| 400 | Check the field names and values |
| 401 | Check your key, workspace and permissions |
| 403 | Check publishing rules; use Postman or your backend |
| 404 | Check that the resource belongs to your workspace |
| 409 | Check conflicting changes or resources still in use |
| 429 | Wait for `Retry-After` before retrying |
| 503 | Retry later; contact support if it persists |

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.

## Related guides

* [Create Platform keys](https://docs.layarva.com/developers/platform-api-keys.md)
* [Make your first request](https://docs.layarva.com/developers/platform-quickstart.md)
* [Idempotency-Key and file checksum examples](https://docs.layarva.com/developers/platform-request-keys.md)
* [Upload files and manage Library folders](https://docs.layarva.com/developers/platform-library.md)
* [Export and download offline packages](https://docs.layarva.com/developers/platform-offline.md)
* [Receive signed Platform webhooks](https://docs.layarva.com/developers/platform-webhooks.md)
* [API reference](https://api.layarva.com/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.