docs: document OpenUI Cloud Responses and Chat Completions APIs - #971
Open
vishxrad wants to merge 3 commits into
Open
docs: document OpenUI Cloud Responses and Chat Completions APIs#971vishxrad wants to merge 3 commits into
vishxrad wants to merge 3 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
vishxrad
force-pushed
the
visharad/api-docs
branch
from
August 13, 2026 11:26
83a968f to
71c4e88
Compare
vishxrad
marked this pull request as ready for review
August 13, 2026 12:50
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Why
The Responses API guidance was distributed across the Cloud docs, while the newly supported Chat Completions surface had no first-class OpenUI documentation. The parallel structure makes both protocols discoverable and lets readers compare equivalent workflows. Shared component-library guidance now has one canonical location instead of drifting between API pages.
Developer impact
Developers can start from a protocol-specific guide, migrate an existing OpenAI Chat Completions integration, or choose Responses for Cloud-managed capabilities. Both API guides point to the same built-in and custom component-library workflow, with API-specific backend request examples.
Validation
pnpm --filter @openuidev/docs types:checkpnpm --filter @openuidev/docs buildgit diff --check