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

# Web reader: let readers listen to your articles

> What the web reader does, who can use it, and how a reading reaches a page: the snippet, the player, conversion on first play, caching and credits.

> [!NOTE]
>
> Web reader is in beta and switched on for selected accounts.

Web reader turns the articles on your website into audio. You add your site in Hamsa Media, paste one snippet into your article template, and a player appears on every article. When a reader presses play, Hamsa reads the page, turns it into speech in the voice you chose, and keeps the audio for the next reader.

![The Web reader list with two sites, one Active and one Inactive, each with its conversions and plays](https://mintcdn.com/hamsa-452fa79a/SjdNHyLOJ-5kYaqE/images/media/web-reader/sites-list-light.webp?fit=max\&auto=format\&n=SjdNHyLOJ-5kYaqE\&q=85\&s=5bc8b3d64527a84ba53260b46777aa22)

## Before you start

* Your account must be on a Pro, Business or Enterprise plan. On a lower plan, the **Web reader** page shows what the web reader does and offers an upgrade, which opens the Plans tab of [Billing](https://docs.tryhamsa.com/overview/billing.md) with only the plans that include it. If your account moves to a lower plan, sites you already set up stop converting articles.
* You need credits. Each reading is charged once, when it is first made. See [Credits](#credits).
* Your articles must be public web pages. Hamsa fetches each page itself, so pages behind a login or a paywall can't be read.

## How it works

**1. Add a site**

In **Web reader**, click **Add site** and enter your domain and a voice. See [Set up a site](https://docs.tryhamsa.com/media/web-reader/set-up-a-site.md).

**2. Choose readings and a look**

On the site's **Settings** tab, pick the readings you offer (English, Modern Standard Arabic, Arabic dialects), a voice for each, dictionaries and the player's look. See [Player appearance](https://docs.tryhamsa.com/media/web-reader/appearance.md).

**3. Add the snippet to your site**

Copy the snippet from the **Setup** tab and paste it once into your article template. See [Add the player to your site](https://docs.tryhamsa.com/media/web-reader/add-to-your-site.md).

**4. Readers press play**

The first time anyone presses play on an article, Hamsa converts it. The audio streams to that reader while it is made, and every later reader gets the saved audio straight away.

## How a reading reaches a page

A **reading** is one version of an article a reader can listen to: English, Modern Standard Arabic, or an Arabic dialect such as Egyptian or Saudi. Each site offers one or more readings, each with its own voice.

1. The snippet loads the player on the article. Nothing is converted yet.
2. A reader presses play. The player sends Hamsa the page address and the reading.
3. Hamsa checks that the site is active, that the page is on your domain (or one of its subdomains), and that you offer that reading.
4. If the reading already exists, it plays at once. If not, Hamsa fetches the page, takes out the article text, translates it when the reading needs it, applies your pronunciation dictionaries, and speaks it.
5. The audio is kept. The page is not read again until you clear the cached audio for that article.

Articles are matched by their address without the query string, so `?utm_source=` and other tracking parameters don't create a second conversion.

### Translation

Hamsa decides the article's language from its script: mostly Arabic letters means Modern Standard Arabic, otherwise English. A reading in the same language plays the text as written. Any other reading is translated first: an Arabic article offered in Egyptian is rewritten in Egyptian, and an English article offered in Arabic is translated into Arabic.

## Credits

Each reading of each article is charged once, when it is first made:

* **Speech**: by the length of the audio produced, at the text to speech rate.
* **Translation**: for readings that need it, by how much text is translated.

Playing audio that already exists costs nothing. Clearing an article's cached audio means the next play makes it again and charges again. Editing one chunk charges speech for that chunk only. Each article's [conversion logs](https://docs.tryhamsa.com/media/web-reader/conversions.md#conversion-logs) show what it cost. See [Billing](https://docs.tryhamsa.com/overview/billing.md).

## Who can use it

Anyone in the project who can open Hamsa Media can add sites and change them. A site belongs to the member who added it: other members of the same project don't see it in their list.

## Good to know

* Articles must have between 50 and 10,000 words. Pages over 5 MB, with more than 5 redirects, or on a private network address are refused, and the player says why.
* Each site can start up to 100 new conversions an hour, and each visitor up to 100 an hour. Plays of existing audio don't count.
* Hamsa never re-reads a page on its own. After you change an article, clear its cached audio so the next play uses the new text.
* The player always shows "Voiced by Hamsa".

## Related

> [card] [Set up a site](https://docs.tryhamsa.com/media/web-reader/set-up-a-site.md)
>
> Add your domain and voice, then follow the Getting this live checklist.

> [card] [Add the player to your site](https://docs.tryhamsa.com/media/web-reader/add-to-your-site.md)
>
> The snippet, inline or floating, and per-page overrides.

> [card] [Conversions and chunks](https://docs.tryhamsa.com/media/web-reader/conversions.md)
>
> Check each article, fix a chunk, read the cost.

> [card] [Analytics](https://docs.tryhamsa.com/media/web-reader/analytics.md)
>
> Plays, completion and devices.


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