Skip to content

docs: update for pipecat PR #4407#806

Open
markbackman wants to merge 1 commit into
mainfrom
docs/pr-4407
Open

docs: update for pipecat PR #4407#806
markbackman wants to merge 1 commit into
mainfrom
docs/pr-4407

Conversation

@markbackman
Copy link
Copy Markdown
Contributor

Automated documentation update for pipecat PR #4407.

Changes

api-reference/server/rtvi/rtvi-processor.mdx

  • Added UI Agent Protocol section documenting the new RTVI 1.3.0 features:
    • New on_ui_message event handler for handling inbound UI messages from clients
    • Three new inbound frames: RTVIUIEventFrame, RTVIUISnapshotFrame, RTVIUICancelTaskFrame
    • RTVIUICommandFrame for sending UI commands to clients (with examples using Toast, Navigate, etc.)
    • RTVIUITaskFrame for sending task lifecycle updates (group started, task update, task completed, group completed)
    • Code examples showing how to handle UI messages and send commands/tasks

api-reference/server/rtvi/rtvi-observer.mdx

  • Updated Frame Translation table to include new UI Agent Protocol frames:
    • RTVIUICommandFrameUICommandMessage
    • RTVIUITaskFrameUITaskMessage

Gaps identified

None

- Add UI Agent Protocol section to rtvi-processor.mdx covering:
  - New on_ui_message event handler
  - RTVIUIEventFrame, RTVIUISnapshotFrame, RTVIUICancelTaskFrame
  - Sending UI commands with RTVIUICommandFrame
  - Sending UI tasks with RTVIUITaskFrame
  - Built-in command payload models (Toast, Navigate, etc.)
- Update rtvi-observer.mdx Frame Translation table to include:
  - RTVIUICommandFrame → UICommandMessage
  - RTVIUITaskFrame → UITaskMessage

Protocol version bumped from 1.2.0 to 1.3.0.
@markbackman markbackman added auto-docs Automated documentation update from pipecat source changes pipecat labels May 8, 2026
@mintlify
Copy link
Copy Markdown

mintlify Bot commented May 8, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
daily 🟢 Ready View Preview May 8, 2026, 12:08 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

auto-docs Automated documentation update from pipecat source changes pipecat

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant