Skip to content

The Open Standard for Generative UI

docs: mention BYOK in OpenUI Cloud (#947)

Visharad Kashyap826d252df46c
diff --git a/docs/content/docs/openui-cloud/get-started.mdx b/docs/content/docs/openui-cloud/get-started.mdx
index e60badecf..a3441cf12 100644
--- a/docs/content/docs/openui-cloud/get-started.mdx
+++ b/docs/content/docs/openui-cloud/get-started.mdx
@@ -34,6 +34,8 @@ yarn dlx @openuidev/cli@latest create --template openui-cloud
npx @openuidev/cli@latest create --template openui-cloud
```
+To add a provider key or choose a supported model, see [Models and BYOK](/docs/openui-cloud/models-and-byok).
+
## Run
Start the dev server:
diff --git a/docs/content/docs/openui-cloud/index.mdx b/docs/content/docs/openui-cloud/index.mdx
index 9925dfdac..36ba04de2 100644
--- a/docs/content/docs/openui-cloud/index.mdx
+++ b/docs/content/docs/openui-cloud/index.mdx
@@ -19,11 +19,12 @@ It combines OpenUI's generative UI capabilities with reliable model access, auto
## What you get
1. **Production hardening:** Run generative UI reliably in production with managed model access, automatic fallbacks, and output validation. Requests are rerouted when a model or provider is unavailable, and generated output is validated before it reaches the interface.
-2. **Generative UI for agents:** Let agents respond with rich, interactive interfaces instead of walls of text. Each response can assemble the components best suited to the task.
+2. **Bring your own model key (BYOK):** Use your own OpenAI, Anthropic, or Google API key with OpenUI Cloud on any plan, including the free tier. See [Models and BYOK](/docs/openui-cloud/models-and-byok).
+3. **Generative UI for agents:** Let agents respond with rich, interactive interfaces instead of walls of text. Each response can assemble the components best suited to the task.
- **Built-in component library:** Use a pre-tested, responsive, and accessible set of components: forms, inputs, interactive charts, accordions, tabs, and other layout components.
- **Bring your own component library:** Generate interfaces using your own components and design system while OpenUI Cloud provides model reliability, output validation, and observability.
-3. **Slides:** Generate presentations from conversations using well-designed templates for charts, images, and structured content. Review decks in an interactive viewer, edit slides manually, and export them to PowerPoint.
-4. **Reports:** Generate long-form documents from conversations using rich components for metrics, charts, tables, images, and structured content. Review reports in a dedicated viewer and export them to PDF.
+4. **Slides:** Generate presentations from conversations using well-designed templates for charts, images, and structured content. Review decks in an interactive viewer, edit slides manually, and export them to PowerPoint.
+5. **Reports:** Generate long-form documents from conversations using rich components for metrics, charts, tables, images, and structured content. Review reports in a dedicated viewer and export them to PDF.
## OpenUI vs. OpenUI Cloud
diff --git a/docs/content/docs/openui-cloud/meta.json b/docs/content/docs/openui-cloud/meta.json
index 10f71745e..6715342fe 100644
--- a/docs/content/docs/openui-cloud/meta.json
+++ b/docs/content/docs/openui-cloud/meta.json
@@ -5,6 +5,7 @@
"index",
"get-started",
"how-it-works",
+ "models-and-byok",
"---Features---",
"build/chat",
"build/slides",
diff --git a/docs/content/docs/openui-cloud/models-and-byok.mdx b/docs/content/docs/openui-cloud/models-and-byok.mdx
new file mode 100644
index 000000000..75d7542e8
--- /dev/null
+++ b/docs/content/docs/openui-cloud/models-and-byok.mdx
@@ -0,0 +1,35 @@
+---
+title: Models and BYOK
+description: "Configure provider keys, choose supported models, and call OpenUI Cloud with the Responses API."
+---
+
+OpenUI Cloud supports both managed model access and bring your own key (BYOK). Both use the same `provider/model` identifiers.
+
+## Bring your own key
+
+Add an OpenAI, Anthropic, or Google API key from the [BYOK page in the Thesys console](https://console.thesys.dev/byok). BYOK is available on every plan, including the free tier.
+
+Only organization admins can add or update provider keys. Once a key is added, every member of the organization can use models from that provider through BYOK.
+
+### Provider-specific billing
+
+BYOK applies only to the matching provider. For example, if your organization adds an OpenAI key, requests to OpenAI models use that key. Requests to Anthropic or Google Vertex AI models are billed against OpenUI Cloud credits instead. If the organization has no credits, those requests fail with an out-of-credits error; otherwise, its credits are used for the requests.
+
+## Supported BYOK models
+
+Model identifiers follow the `provider/model` convention. For example, use `openai/gpt-5.5`, not `gpt-5.5`.
+
+| Provider | Model name | Model identifier |
+| --------- | ---------------------- | ------------------------------- |
+| Anthropic | Claude Sonnet 5 | `anthropic/claude-sonnet-5` |
+| Anthropic | Claude Sonnet 4.6 | `anthropic/claude-sonnet-4.6` |
+| Anthropic | Claude Opus 4.7 | `anthropic/claude-opus-4-7` |
+| Google | Gemini 3.6 Flash | `google/gemini-3.6-flash` |
+| Google | Gemini 3.5 Flash | `google/gemini-3.5-flash` |
+| Google | Gemini 3.1 Pro Preview | `google/gemini-3.1-pro-preview` |
+| OpenAI | GPT-5.5 | `openai/gpt-5.5` |
+| OpenAI | GPT-5.4 | `openai/gpt-5.4` |
+| OpenAI | GPT-5.4 mini | `openai/gpt-5.4-mini` |
+| OpenAI | GPT-5.2 | `openai/gpt-5.2` |
+| OpenAI | GPT-5.1 | `openai/gpt-5.1` |
+| OpenAI | GPT-5 | `openai/gpt-5` |