Auto Audio

Widget reference

What the Auto Audio script exposes on the page: the window.Everlit namespace, version reporting, and the status field on every response.

Widget v2

Version 3.0.0 of everlitAutoAudio.js shipped on 2026-09-02. The install snippet, the widget container attributes, and the event names are unchanged — existing integrations keep working. Three things are new.

What Changed

Change	Details
Namespaced globals	The widget no longer defines page globals. Everything it exposes lives under `window.Everlit.autoAudio`.
Configurable host	Optional `data-everlit-host` attribute on the script tag or the widget container — see API host.
Status on every response	Widget responses carry a `status` field, plus `article_id` and `player_url` when the article is known — see Response status.

The `window.Everlit` Namespace

window.Everlit is shared with the Everlit playlist embed; the Auto Audio widget only ever writes under Everlit.autoAudio.

Property	Type	Description
`Everlit.autoAudio.version`	string	The loaded widget version, e.g. `"3.0.0"`
`Everlit.autoAudio.host`	string	The resolved API origin, e.g. `"https://creator.everlit.audio"`
`Everlit.autoAudio.initialized`	boolean	`true` once the widget has run its initialization for this page view
`Everlit.autoAudio.load()`	function	Loads the player for the current page and returns a Promise. See Single-Page Apps.
`Everlit.autoAudio.cmd`	array-like	Command queue: functions pushed before the script loads run once it has; functions pushed afterwards run immediately

document.addEventListener('everlit:ready', function () {
  console.log(window.Everlit.autoAudio.version);      // "3.0.0"
  console.log(window.Everlit.autoAudio.host);         // "https://creator.everlit.audio"
  console.log(window.Everlit.autoAudio.initialized);  // true
});

Migrating: earlier builds happened to leave some everlit* variables on window. Those were never documented and are gone in v2. If you read one, switch to the matching property on window.Everlit.autoAudio. Nothing else needs to change — the DOM events remain the supported integration point.

Version Reporting

The widget identifies itself on every request so support can tell which build a page is running:

POST /audio/auto — client_version in the JSON body
GET /audio/auto/check — client_version inside the encoded evp parameter

Request volume is unchanged. The widget makes at most one GET /audio/auto/check and one POST /audio/auto per page view. It does not poll.

Response Status

Every response the widget receives now includes a status string. All previously documented fields (successful, embed, waiting, create, metadata, reason, …) are still present, so existing field checks keep working — status is the simpler way to branch.

Status	Meaning
`ready`	A playable embed is returned. Also used when `regenerating: true` — the existing audio plays while a newer version is being produced.
`paywalled`	The publication paywalls audio and this visitor is blocked. `embed` is the blurred placeholder with the subscribe call-to-action, not a player; `paywalled: true` is also set.
`processing`	A worker is converting this article right now; audio is not playable yet.
`queued`	Nothing is running yet: the request was accepted and is waiting on the touch-count threshold or on conversion capacity.
`click_to_create`	No audio yet; the click-to-create widget is offered to the reader.
`unavailable`	There is no audio and none will be created for this request — for example a crawler hitting a cache miss.
`error`	The check or conversion failed. See `reason`.

Article Identifiers

Field	Type	Description
`article_id`	string	Present whenever the article is known, e.g. `"artl_abc123"`
`player_url`	string	The public player page for the article, e.g. `https://everlit.audio/embeds/artl_abc123`. Useful for share links and "listen elsewhere" affordances.