docs: publish Livestream API section - #414
Merged
Merged
Conversation
Bring the livestream-api/ guides and endpoint pages from the livestream-api branch onto main and add the "Livestream API" product to docs.json navigation. openapi.json and the x-api/broadcasts/* stub pages are intentionally not taken from the branch: main's spec (v2.168) already contains every broadcast change made on that branch, and the branch copy (v2.167) is otherwise stale.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Add Enterprise-only callouts pointing to the Enterprise interest form on the Introduction, Getting Started, and Scheduling overview pages, and replace "contact your partner manager" / allow-list wording on the Authentication page. Also fix content that was stale or not customer-ready: - Remove the Scheduling overview note claiming the management endpoints accept only OAuth 1.0a; it contradicted the Authentication page. - Replace the "WebSocket flow" reference on Send a Chat Message with the X Activity API broadcast.chat event the chat page now documents. - Reword the Broadcasts overview deprecation note to drop references to backend work and Periscope. - Replace "observed as" phrasing for the chat_option default and the is_high_latency field with plain statements.
Collaborator
Author
|
Second commit: Enterprise-only positioning and production cleanup. Enterprise access messaging (links to
Content fixes found during review:
Verified locally: all 32 pages serve, form link resolves to the Enterprise Access Form page, no broken links. |
Contributor
|
Docs PR opened: #415 Added a Sep 15, 2026 changelog entry announcing the Livestream API launch with links to its overview pages. |
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
Publishes the Livestream / Broadcast API documentation from the
livestream-apibranch ontomain.livestream-api/directory (32 pages: overview guides, Stream Sources, Broadcasts, Scheduled Broadcasts, Live Chat).docs.jsonnavigation, listed after Ads API.What was intentionally left out
The
livestream-apibranch was 215 commits behindmain, so instead of merging it wholesale this PR was built fresh on top ofmain:openapi.json— main's spec (v2.168, regenerated 2026-09-15) already contains every broadcast change made on the branch (scheduled_end_msoptional,end_at_mson mutes, chat moderation descriptions, etc.). The branch copy (v2.167) is otherwise stale and missing newer schemas.x-api/broadcasts/*.mdxand otherx-api/*stubs — already present onmain.Verification
openapi:frontmatter references resolve to operations in main'sopenapi.json.mintlify devlocally: every livestream page returns 200 with no MDX compile errors; product switcher shows X API / Chat API / Ads API / Livestream API; OpenAPI-backed pages render Body/Response/Try-it; existing X API, Chat API, and Ads API pages still serve. Checked desktop and mobile viewports.