Fix LLMS.txt wrong info by marking v0.2 stream info and keepalive endpoints as deprecated to h - #10
Open
mintlify[bot] wants to merge 4 commits into
Open
Fix LLMS.txt wrong info by marking v0.2 stream info and keepalive endpoints as deprecated to h#10mintlify[bot] wants to merge 4 commits into
mintlify[bot] wants to merge 4 commits into
Conversation
Mintlify-Source: dashboard-editor
zakariaelh
reviewed
May 3, 2026
| title: "Keepalive" | ||
| openapi: "api-reference/v0.2/openapi.json POST /streams/{stream_id}/keepalive" | ||
| hidden: true | ||
| deprecated: true |
Contributor
There was a problem hiding this comment.
can you also update the keepalive guidelines in the documentation to match v1?
Mintlify-Source: dashboard-editor
Mintlify-Source: dashboard-editor
setarehlotfi
reviewed
May 4, 2026
| - **`id`** — pass this in every later URL: `/v1/streams/{id}/...` plus stream URLs you embed in chat completion messages. | ||
| - **`publish.url`** + **`publish.token`** — feed these to a [LiveKit client SDK](https://docs.livekit.io/reference/) to connect a video source. Any LiveKit publisher works (browser, native, server-to-server). The token is short-lived; use the one returned by `/keepalive` if your publisher reconnects later. | ||
| - **`expires_at_ms`** + **`ttl_seconds`** — the lease deadline. Call `/keepalive` before it elapses (every ~2 minutes is safe). After expiry the stream's `state` flips to `ended` and stays there. | ||
| - **`publish.url`** \+ **`publish.token`** — feed these to a [LiveKit client SDK](https://docs.livekit.io/reference/) to connect a video source. Any LiveKit publisher works (browser, native, server-to-server). The token is short-lived; use the one returned by `/keepalive` if your publisher reconnects later. |
There was a problem hiding this comment.
I don't have direct right access into this repo so need to update it via mintlify GUI which seems like changes the formatting of string
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
2 participants
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
This update marks the
stream-infoandkeepalive-streamendpoints within the v0.2 API reference as deprecated. A warning note has been added to both documentation pages, advising new integrations to utilize the v1 API.Changes
api-reference/v0.2/stream-info.mdx.stream-infoendpoint as deprecated in its frontmatter.api-reference/v0.2/keepalive-stream.mdx.keepalive-streamendpoint as deprecated in its frontmatter.Mintlify
0 threads from 0 users in Mintlify