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

# Widget API

> Send data to Studio elements and supported Widgets.

The Widget API updates data shown in supported Studio elements. It is separate from the Platform API, which manages Library, Playlists, Channels and Screens.

## Get your Widget key

1. Sign in to your workspace.
2. Open **Settings → API Keys → Widget API Key**.
3. Create a key and save it securely.
4. Follow the guide for the element you want to update.

Use a Widget key only with the documented Widget or prayer-schedule integration. It cannot manage Platform resources, and a Platform key cannot replace it.

Older examples may call this a Workspace API Key. In Settings, it is now clearly named **Widget API Key**. Existing authentication headers keep working.

## Choose an integration

* [Structured Widget Push](https://docs.layarva.com/developers/structured-widget-push.md): send a new data snapshot to a supported Widget.
* [Prayer Schedule Push](https://docs.layarva.com/developers/prayer-schedule-push.md): send a complete month of prayer times.
* [Widget WebSocket](https://docs.layarva.com/developers/widget-websocket.md): connect supported live data using the documented protocol. This protocol has its own connection settings.

Each guide explains the required headers, data format and examples. Keep your key private; do not place it in a public Design or share it in screenshots.

## Related guides

* [Widget data sources in Studio](https://docs.layarva.com/studio/widget-data-sources.md)
* [Platform API](https://docs.layarva.com/developers/platform-api.md)


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