[Agents] Document 0.21 telephony, chat transport, and URL builders - #32584
Draft
cjol wants to merge 1 commit into
Draft
[Agents] Document 0.21 telephony, chat transport, and URL builders#32584cjol wants to merge 1 commit into
cjol wants to merge 1 commit into
Conversation
Adds Plivo and Telnyx telephony coverage, the framework-neutral WebSocketChatTransport, and the buildAgentPath/buildAgentUrl helpers. Telephony is organised by approach rather than by provider, with runnable setup deferred to the upstream examples.
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
Contributor
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
1 participant
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.
Summary
Documents three surfaces added in Agents SDK 0.21 that had no docs coverage:
WebSocketChatTransportfromagents/chat/transportfor non-React clientsbuildAgentPath()andbuildAgentUrl()for canonical Agent URLsOn the telephony restructure. The page previously had a
## Telephony (Twilio)section. Adding two more providers as sibling walkthroughs would have tripled a section that was already the densest on the page, so it is now organised by approach rather than by provider — Twilio and Plivo share one section because they are the same architecture (a server-side adapter terminating the provider's audio WebSocket in your Worker), while Telnyx is separate because it bridges WebRTC in the browser.The section explains where call audio lands, the 8 kHz mulaw ↔ 16 kHz PCM conversion, the browser-credential constraint, and the
WorkersAITTSMP3/PCM footgun. Runnable setup is deferred to the upstream examples viaLinkCard, following the approachslack.mdxalready takes for a channel with comparable provider-side configuration:examples/plivo-voice-agentexamples/telnyx-voice-agentThis keeps provider-specific wiring — XML attributes, JWT endpoint construction, application provisioning — in one place upstream rather than duplicated here where it would drift.
Documentation checklist