Skip to content

docs: document OpenUI Cloud Responses and Chat Completions APIs - #971

Open
vishxrad wants to merge 3 commits into
mainfrom
visharad/api-docs
Open

docs: document OpenUI Cloud Responses and Chat Completions APIs#971
vishxrad wants to merge 3 commits into
mainfrom
visharad/api-docs

Conversation

@vishxrad

@vishxrad vishxrad commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

What changed

  • Add dedicated Responses API and Chat Completions API guides.
  • Align both guides around the same client setup, managed request, streaming/rendering, history, tools, artifacts, BYOK, and API-choice structure.
  • Add one shared Component Library feature guide with parallel Responses and Chat Completions examples for the built-in library and custom libraries.
  • Keep protocol-specific behavior explicit: Chat passthrough and self-hosted prompt assembly; Responses persistent conversations and hosted tools.
  • Add the API and Component Library guides to the OpenUI Cloud navigation.
  • Update the Cloud architecture and quickstart docs to distinguish the Responses and Chat Completions lifecycles.

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:check
  • pnpm --filter @openuidev/docs build
  • Prettier on changed docs
  • git diff --check
  • GitHub Build JS, build-examples, and Vercel checks

@vercel

vercel Bot commented Aug 13, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
openui-docs Ready Ready Preview Aug 13, 2026 1:13pm

Request Review

@vishxrad
vishxrad marked this pull request as ready for review August 13, 2026 12:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant