docs: Add WebSocket streaming tutorial for Serverless

[promptless]

Open this suggestion in Promptless to view citations and reasoning process

Creates a new tutorial at tutorials/serverless/websocket-streaming.mdx that walks through building a Serverless endpoint with WebSocket-style streaming. The tutorial includes creating a streaming handler that yields incremental results, packaging it in a Docker image, deploying to an endpoint, and testing with a Python client. Includes updated UI screenshots for the endpoint creation workflow.

Trigger Events

Internal discussion about rewriting a websocket streaming tutorial for RunPod Serverless, with instructions to update outdated UI steps while keeping the code intact.

Agent Response

I've completed the WebSocket streaming tutorial for Serverless. Here's a summary of what I created:

New documentation

Tutorial: tutorials/serverless/websocket-streaming.mdx

A comprehensive tutorial that walks through building a Serverless endpoint with WebSocket-style streaming. The tutorial includes:

• What you'll learn and Requirements sections (per style guide)

• 6 numbered steps covering the full workflow:

  1. Set up development environment
  2. Create a streaming handler function (using yield and return_aggregate_stream)
  3. Create a Dockerfile and requirements.txt
  4. Build and push Docker image
  5. Create a Serverless endpoint (with fresh UI screenshots)
  6. Test the endpoint with a Python client

• Next steps section linking to related documentation on streaming handlers, the /stream operation, and concurrent handlers

UI screenshots updated

Since you mentioned the UI steps were out of date, I captured fresh screenshots of the current Runpod console for:

• The "Deploy a New Serverless Endpoint" page showing import options
• The Container Configuration page with the image URL field
• The endpoint configuration page with GPU options

Navigation updated

Added the tutorial to docs.json in the Examples tab → Serverless group, positioned after "run-your-first" as a natural follow-up tutorial.

Code preserved

All the handler code, Dockerfile, requirements.txt, and test script code from your message has been included with proper syntax highlighting and filenames.

You can review the suggestion here: https://app.gopromptless.ai/change-history/652a9802-cd7f-4112-9c83-959458d22f2a

---

Tip: Enable auto-create PR in your Project to publish suggestions automatically 🤖

[promptless]

Citation: Tutorial content based on Mo King's Slack message with handler.py streaming handler code, test_endpoint.py client code, and Dockerfile/requirements.txt configuration. Rewrote the prose and updated UI steps with fresh screenshots.
View source