> For the complete documentation index, see [llms.txt](https://docs.convai.com/api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.convai.com/api-docs/plugins-and-integrations/convai-pixel-streaming-embed.md).

# Convai Pixel Streaming Embed

Find the guides and API reference for embedding a published Convai Pixel Streaming experience in a website with React, JavaScript modules, or a script tag.

Convai Pixel Streaming Embed puts a published Avatar Studio experience on your own website. The `@convai/experience-embed` package renders the experience, streamed from Convai, in an iframe on your page, and lets your code control its camera, audio, microphone, and chat. The current release is <code class="expression">space.vars.experience\_embed\_version</code>.

Start by publishing the experience and choosing how to authorize it, then follow the guide for your stack.

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Publish and authorize an experience</strong><br>Get the experience ID, and authorize the embed with an auth token or an allowlisted domain.</td><td><a href="/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/whitelisting-and-publishing-an-experience.md">Publish and authorize an experience</a></td></tr><tr><td><strong>Embed an experience in a React TypeScript app</strong><br>Install the package, render the experience, and control it from your own interface.</td><td><a href="/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/react-typescript.md">Embed an experience in a React TypeScript app</a></td></tr><tr><td><strong>Embed an experience in a React JavaScript app</strong><br>The same component in a React app written in JavaScript.</td><td><a href="/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/reactjs-javascript.md">Embed an experience in a React JavaScript app</a></td></tr><tr><td><strong>Embed an experience with JavaScript modules</strong><br>Use the framework-free client from a module script, without React.</td><td><a href="/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/vanilla-javascript-es-modules.md">Embed an experience with JavaScript modules</a></td></tr><tr><td><strong>Embed an experience with a script tag</strong><br>Load the package from a CDN in a plain HTML page with no build step.</td><td><a href="/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/cdn-umd-script.md">Embed an experience with a script tag</a></td></tr><tr><td><strong>Configure an on-premise deployment</strong><br>Point the embed at your own session service and stream servers.</td><td><a href="/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/on-premise-deployment.md">Configure an on-premise deployment</a></td></tr><tr><td><strong>Pixel Streaming Embed API reference</strong><br>Every prop, option, method, callback, and error message.</td><td><a href="/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/api-reference.md">Pixel Streaming Embed API reference</a></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.convai.com/api-docs/plugins-and-integrations/convai-pixel-streaming-embed.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.