Skip to content

fix(docs): http API inaccuracy #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
streamer45 merged 1 commit into from
Dec 29, 2025
+1 −3
Merged

fix(docs): http API inaccuracy #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions docs/src/content/docs/reference/http-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,7 @@ Destroy a session:

**Max body size**: Configurable via `[server].max_body_size` (default: 100 MB).

If `media` is provided, the pipeline must include `streamkit::http_input` and typically ends with `streamkit::http_output`.

If `media` is not provided, the pipeline must include `core::file_reader` and must not include `streamkit::http_input`. In both cases, `streamkit::http_output` is required.
If `media` is provided, the pipeline must include `streamkit::http_input` to receive it. If no media is needed, `streamkit::http_input` can still be used as a trigger (with empty body) or the pipeline can rely solely on `core::file_reader`. Both nodes can be used together (e.g., mixing uploaded audio with a local file). In all cases, `streamkit::http_output` is required.

> [!NOTE]
> `streamkit::http_input` and `streamkit::http_output` are **oneshot-only marker nodes**. They are available in schema discovery, but they cannot be used in dynamic sessions.
Expand Down
Loading