Put Clarity™ inside your website or product
Your readers get the same reading Clarity™ gives on its own site: what matters first, every figure checked, questions answered with the lines they come from, in twelve languages. You add one line, or call one endpoint.
Try it live for 14 days Talk to us on WhatsAppHow to start, in four steps
- Ask for a test key. Message us with your website. You get a
pk_test_key for pages and ask_test_key for servers. Test keys return a sample reading, work on localhost and your staging site, and cost nothing. - Add the embed to a page. Paste one line before
</body>. A "Make sense of this" button appears and reads the page it sits on. - Build against the API, if you need it. Same keys, same response shape as live.
- Go live. Choose a plan, tell us your domains, and swap the test keys for live ones. Nothing else changes.
The website embed
Reads the page it is placed on. Works on any site: plain HTML, WordPress, Webflow, Shopify, React or anything else that can include a script.
<script src="https://clarity.craydesignz.com/embed.js" data-key="pk_live_your_key" data-reader-token="TOKEN_FROM_YOUR_SERVER" defer></script>
Reader tokens are an extra lock you can switch on in your console. Once on, your server asks for a reader token for each page it serves, using your secret key, and writes it into data-reader-token. A token lasts 30 minutes. With it on, a copied publishable key is useless anywhere else. Keep it off if your pages are static and have no server; your domain list and spending limits still guard the key. Test keys never need one.
curl -X POST https://clarity.craydesignz.com/v1/reader-token \
-H "Authorization: Bearer sk_live_…" \
-H "Content-Type: application/json" \
-d '{"reader":"user-123"}'
Options
| Attribute | What it does |
|---|---|
data-key | Your publishable key. It only works on the domains registered for it. |
data-reader-token | The reader token your server asked for, when reader tokens are on for your live key. It lasts 30 minutes. |
data-target | A CSS selector for the part of the page to read, for example #report. Default: the main content. |
data-label | The button text. Default: "Make sense of this report". |
data-lang | The starting language: en, pcm, yo, ig, ha, efi, tw, sw, fr, es, zh, hi. Readers can still change it. |
data-reader | Who the reader is, for example "an investor" or "a tenant". Clarity™ frames the reading for them. |
data-floating | auto (default), always or never for the floating button. Any element with data-clarity also opens the panel. |
The server API
For reading documents inside your own product. Keep the secret key on your server, never in a page or an app.
Read a document
curl https://clarity.craydesignz.com/v1/read \
-H "Authorization: Bearer sk_live_your_key" \
-H "Content-Type: application/json" \
-d '{"text": "The full document text...", "reader": "a small business owner"}'
# or let Clarity™ fetch a public page
-d '{"url": "https://example.com/annual-report"}'
Returns { "digest": { ... }, "cached": false, "usage": { ... } }. The digest holds the one line summary, quick, clear and deep readings, the figures that matter, findings with their basis, what to watch, options for the reader, a glossary and more. Reading the same text again is instant and uses nothing more.
Ask a question
curl https://clarity.craydesignz.com/v1/ask \
-H "Authorization: Bearer sk_live_your_key" \
-H "Content-Type: application/json" \
-d '{"text": "The full document text...", "question": "What do I owe and when?", "language": "yo"}'
Check your usage
curl https://clarity.craydesignz.com/v1/usage -H "Authorization: Bearer sk_live_your_key"
Errors
| Status | Meaning |
|---|---|
| 401 | The key is missing or not recognised. |
| 403 | The key cannot do this: it is paused, the domain is not registered, or it does not include what you asked for (error not_in_plan, with the product named). A key reaches only the products switched on for it; ask us and we add one. |
| 402 | This month's lumens are used up. Top up or move to a larger plan. |
| 413 | The document is too large (about 60,000 words). |
| 429 | Slow down: a daily or per minute limit was reached. |
| 502, 503 | The reading engine is busy. Try again shortly. |
Plans for platforms
Lumens work the same way as on Clarity™ itself: a reading starts from 4 lumens (5 from 22 November 2026, as announced), a question from 2, and opening anything already read uses no lumens.
Sandbox keys for building. Works on localhost and your staging site and returns a sample reading, so testing costs nothing.
Clarity™ on one website: a "Make sense of this" button on any page your readers open.
Up to five sites, plus the server API so your own product can read documents with Clarity™.
High volume, your own terms, a named contact and an agreed response time.
Try it live, with your own documents
A live trial gives your team real readings for 14 days: 300 lumens, the website embed and the server API, on up to 3 of your domains. Tell us who you are and we send your keys, usually within a day.
Fair use and safety
- Publishable keys only work on your registered domains. Secret keys never leave your server.
- Every key has a daily limit and every network a per minute limit, so a runaway script cannot run up your bill.
- Documents are read and not kept by Clarity™. Readings are cached so repeats are instant.
- Clarity™ explains and suggests options. It is not legal, financial, tax, investment or medical advice, and decisions stay with your readers.
- Using Clarity™ in your product comes with a short plain-language API and Platform Agreement, which you accept in your console.
Clarity™ · clarity.craydesignz.com · llms.txt for AI agents