New file upload example by mattieruth · Pull Request #237 · pipecat-ai/pipecat-examples

mattieruth · 2026-07-16T20:10:33Z

No description provided.

New example showing how clients can upload local files or reference URLs as visual context during a voice conversation. Uses RTVIProcessor with uploads_folder on the server and client.sendFile via the RTVI protocol.

…/../../pipecat with a "remove before merge" TODO comment. - bot.py: guards cli_args/uploads_folder access so it won't crash on Pipecat Cloud. - app.js: URL format parsing uses new URL().pathname (handles query strings, rejects invalid URLs), the .catch().then() chains are reordered so success messages don't render after failures, and bot text is HTML-escaped before the innerHTML insertions. - README.md: added a note about Pipecat Cloud caveat that large-file upload needs a production /files endpoint.

kompfner · 2026-07-28T13:27:03Z

+conversation context. The LLM can then reason about the uploaded content and
+respond with audio as it would for any other user turn.
+
+Concepts this example is meant to demonstrate:


Nice overview

kompfner · 2026-07-28T13:28:05Z

+4. **Run the bot**:
+
+   ```bash
+   uv run bot.py -u /tmp/uploads


Worth having a default temp location if one is not specified? Simplifies usage.

you don't think that's a privacy/security issue? the runner will use this location to store and delete files. It felt a little presumptive to me to make a default.

I meant just for this example, which exists only to show file uploading. Not proposing baking anything into the runner itself.

kompfner · 2026-07-28T13:29:05Z

+   # Edit .env.local if needed (defaults to localhost:7860)
+   ```
+
+   > **Note:** Environment variables in Vite are bundled into the client and exposed in the browser. For production applications that require secret protection, consider implementing a backend proxy server to handle API requests and manage sensitive credentials securely.


kompfner · 2026-07-28T13:33:09Z

+        user_params=LLMUserAggregatorParams(vad_analyzer=SileroVADAnalyzer()),
+    )
+
+    rtvi = RTVIProcessor(uploads_folder=runner_args.cli_args.uploads_folder)


This is the only configuration needed on the bot server side? That's pretty sweet.

Amazing 🎉

correct. and even then it's only needed if you are supporting an endpoint for the client to upload files to. As @vipyne points out in her PR, PipecatCloud does not have an endpoint for this as of yet, so in that case, uploads_folder should be None and the client will only be able to upload either small files that can be sent wholesale over the transport message channel or urls.

Since we have this (hopefully temporary) limitation today, we ought to mention it in the README, which presents Pipecat Cloud as a deployment option.

i believe it is already 🤔

kompfner · 2026-07-28T13:34:02Z

+
+This bot uses a cascade pipeline: Speech-to-Text → LLM → Text-to-Speech
+
+Generated by Pipecat CLI


So there's also some new CLI affordances coming for configuring a bot to accept file uploads?

i don't have any cli changes planned but maybe i should? When I started this example, I generated it using the CLI which adds this line (and 98% of the lines in this file). Maybe I should remove this comment?

but maybe i should?

I'd have to refresh myself on the existing CLI options to see if something like "accept file uploads" would fit in...without going through them, I have no preference.

this line

I wonder if, if the intent of the CLI is to provide a starting point or scaffold that the user will then build on top of, this line should instead read "Bootstrapped by Pipecat CLI" or something. "Generated by" might lead the reader to believe this file is "managed" by a tool and shouldn't be edited. This is obviously an issue outside the scope of this PR. WDYT, @markbackman?

filipi87 · 2026-07-28T14:18:56Z

+ * This file is auto-generated by pipecat-cli
+ */
+
+export const AVAILABLE_TRANSPORTS = [


Should we add the websocket here ?

filipi87 · 2026-07-28T14:21:00Z

+    "@pipecat-ai/client-js": "file:../../../pipecat-client-web/client-js",
+    "@pipecat-ai/daily-transport": "file:../../../pipecat-client-web-transports/transports/daily",
+    "@pipecat-ai/small-webrtc-transport": "file:../../../pipecat-client-web-transports/transports/small-webrtc-transport"


TODO: Remember to fix this before merging. 🙂

filipi87 · 2026-07-28T14:23:01Z

+        option.textContent = 'SmallWebRTC';
+      } else if (transport === 'daily') {
+        option.textContent = 'Daily';
+      } else if (transport === 'websocket') {


Here we're mentioning websocket, but we don't have it in either the dependencies or AVAILABLE_TRANSPORTS. I think we just need to decide whether we want to support it or remove it.

oh, i don't think i meant to support it. though, i should test that...

actually. i went ahead and added support :)

filipi87 · 2026-07-28T14:25:26Z

+[tool.uv.sources]
+pipecat-ai = { path = "/Users/mattieruth/src/pipecat/pipecat", editable=true }


TODO: Remember to fix this before merging. 🙂

filipi87 · 2026-07-28T14:26:57Z

I don't think any of the other examples have this. Are we planning to keep it?

i can remove it. like i said, I generated this example using the CLI and so some of the stuff was just basic scaffolding. though, in chatting with @markbackman, it seemed like maybe i should leave it? i have no preference/opinion.

filipi87 · 2026-07-28T14:27:07Z

Same here. I don't think any of the other examples have this. Are we planning to keep it?

same reply :)

Vp new file upload example

kompfner · 2026-07-28T18:00:19Z

+    )
+
+    # cli_args is only populated when running via the development runner (not on
+    # Pipecat Cloud, where there is no uploads endpoint and large-file upload is


Wait, so small-file upload is available even when uploads_folder is None?

yes because those can fit in a basic message.

…ists

mattieruth requested review from filipi87, kompfner and markbackman July 16, 2026 20:10

mattieruth mentioned this pull request Jul 16, 2026

Rtvi send file support pipecat-ai/pipecat#3415

Open

add file-upload example demonstrating client file/image uploads

362e8f3

New example showing how clients can upload local files or reference URLs as visual context during a voice conversation. Uses RTVIProcessor with uploads_folder on the server and client.sendFile via the RTVI protocol.

mattieruth force-pushed the new-file-upload-example branch from 517490a to 362e8f3 Compare July 23, 2026 21:17

vipyne added 2 commits July 27, 2026 21:50

env file name tweak

fda1602

kompfner reviewed Jul 28, 2026

View reviewed changes

Comment thread file-upload/client/src/app.js

kompfner reviewed Jul 28, 2026

View reviewed changes

Comment thread file-upload/client/src/app.js

kompfner approved these changes Jul 28, 2026

View reviewed changes

filipi87 reviewed Jul 28, 2026

View reviewed changes

Merge pull request #239 from pipecat-ai/vp-new-file-upload-example

83b76aa

Vp new file upload example

kompfner reviewed Jul 28, 2026

View reviewed changes

mattieruth added 2 commits July 28, 2026 16:23

tmp: adding websocket package. update to non-local version once it ex…

d355742

…ists

Add default upload file folder and support for WebSocketTransports

6aa7c9f


		This bot uses a cascade pipeline: Speech-to-Text → LLM → Text-to-Speech

		Generated by Pipecat CLI

		[tool.uv.sources]
		pipecat-ai = { path = "/Users/mattieruth/src/pipecat/pipecat", editable=true } No newline at end of file

Uh oh!

Conversation

mattieruth commented Jul 16, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kompfner Jul 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kompfner Jul 28, 2026 •

edited

Loading