WXI

Documentation

How to wire WXI into your website, web application, or backend service.

Overview

WXI is designed for swift integration. Most web applications are live in under fifteen minutes. The lightweight embed script runs under 10 KB, makes no third-party calls, and uses no cross-site cookies.

1. Script tag integration (HTML / Websites)

Add the snippet to the pages where your Point of Experience begins and ends.

<!-- Before the experience -->
<script src="https://getwxi.com/embed/v1/wxi.js" data-wxi-key="<WXI_PUBLISHABLE_KEY>" data-wxi-poe="<POE_ID>" data-wxi-auto="pre" defer></script>
<!-- After the experience -->
<script src="https://getwxi.com/embed/v1/wxi.js" data-wxi-key="<WXI_PUBLISHABLE_KEY>" data-wxi-poe="<POE_ID>" data-wxi-auto="post" defer></script>

2. React and Next.js applications

Load the script once in your root layout. Single-page applications trigger readings either via HTML attributes on interactive elements (data-wxi-ask="pre") or through client components that dispatch on mount.

3. REST API

For mobile apps, server-side services, and physical kiosks, submit readings directly to our capture endpoint:

POST https://getwxi.com/api/v1/responses
Header: X-WXI-Key: <WXI_PUBLISHABLE_KEY>
{ "poe": "<POE_ID>", "kind": "pre", "value": 80 }

Pre responses return a pairing identifier to link with the subsequent post reading.

AI Coding Agent Prompt & LLM Reference

You can hand our turnkey integration prompt directly to your AI coding agent. View the prompt on our installation section or within your workspace setup page. Machine-readable documentation is also published at /llms.txt and /llms-full.txt.