Quickstart - Streampixel

The fastest path from a fresh account to a live URL anyone can open. For a stepped walkthrough with screenshots, use the full Get Started flow instead.

Before you begin

Requirement	Notes
Streampixel account	Sign in with Google, Microsoft, or email at dashboard.streampixel.io.
Packaged Unreal build	A `.zip` of a Windows package. See Prepare your Unreal build — and Prepare a VR experience for the extra in-engine steps if you’re building for VR.
Public download URL	Required only if you upload via the API. Any direct-download link works (S3, GCS, etc.).

Steps

Open dashboard.streampixel.io and sign in. See Register and sign in for the available methods.

Create a project and pick a region

From the dashboard, click New Project. Choose one of three deployment regions:

Region	Code	Best for
US-East-1	`us-east-1`	North America
Europe	`europe`	EMEA
Asia Pacific	`asia-pacific`	APAC

Pick the region closest to most of your end users. Region is fixed for the life of the project — see Regions for details.

Package an Unreal build

From the Unreal Editor, package your project for Windows. (For VR experiences you still package for Windows — the difference is in-engine setup, see Prepare a VR experience.) Compress the resulting folder into a single .zip file.

The default build cap is 24 GB — a soft limit to discourage accidental abuse. If your build is genuinely larger, open a support ticket and we’ll raise it at no extra cost. Cooked content, unused plugins, and editor symbols are the usual culprits when builds bloat.

Upload the build

You can upload through the dashboard or directly via the REST API.

Dashboard
REST API

Open your project’s Builds tab.
Click Upload Build and either drag the .zip in or paste a public download URL.
Submit. The build immediately enters the build lifecycle.

Walkthrough: uploading your build.

curl -X POST https://api.streampixel.io/pixelStripeApi/projects/upload-file \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "[YOUR_API_KEY]",
    "userId": "[YOUR_USER_ID]",
    "projectId": "[YOUR_PROJECT_ID]",
    "fileUrl": "https://your-bucket.s3.amazonaws.com/MyBuild.zip",
    "autoRelease": true
  }'

Full reference: Upload File API.

Upload and distribute calls are rate-limited to 1 request per 2 minutes per user.

Wait for approval

The build moves through several states — pending, Downloading Files, Extracting & Scanning, Saving to Repository, Distribute, then Approved (or Reject). Watch progress on the dashboard or subscribe to webhooks.

Configure a webhook URL in Project Settings to get notified when the build hits build.approved. See Webhooks.

Open your share link

Once approved, the project’s Share panel exposes a hosted URL like https://share.streampixel.io/{projectId}. Open it in any browser — desktop, mobile, or VR headset — and your stream is live. That URL is all you need to send to viewers.

Verify the stream

Open the share URL in Chrome on a desktop machine. You should see:

A loading screen while your stream is set up.
The Unreal Engine viewport, streaming live in the browser.
Mouse, keyboard, and touch input flowing back into the build.

If you see a queue or “no worker available” message, your project’s worker pool is busy — see session lifecycle.

What’s next

Embed in your site

Drop the share link into an iframe on your own page.

Build a custom player

Use the Web SDK for full programmatic control: events, JSON messaging, custom UI.

Tune your project

Codec, resolution, AFK timeouts, security.

Webhooks

Get notified at every stage of the build pipeline.

Documentation Index

​Before you begin

​Steps

​Verify the stream

​What’s next

Embed in your site

Build a custom player

Tune your project

Webhooks

Before you begin

Steps

Verify the stream

What’s next