Upload File API
Submit a packaged Unreal Engine build to a Streampixel project by providing a public download URL.
POST
Upload a packaged Unreal Engine build (
.zip) to your Streampixel project by providing a publicly accessible download URL. This is the endpoint used by CI/CD pipelines, automation tools, and the official Unreal plugin.
Typical workflow
1
Build
Compile your Unreal Engine project.
2
Package
Package the build into a
.zip file.3
Upload to your storage
Upload the
.zip to your own cloud storage (S3, GCS, etc.) and obtain a public download link.4
Call this API
Submit the public link to Streampixel via this endpoint.
Prerequisites
File URL requirements
Supported hosting:- AWS S3 (signed or public URL)
- Google Cloud Storage
- DigitalOcean Spaces
- Any HTTP-accessible file server
Request body
string
required
Your Streampixel API key. See API authentication.
string
required
The ID of the account that owns the project.
string
required
The project to upload the build to.
string
required
Public direct-download URL of the
.zip build file.boolean
default:"true"
When
true, the build is automatically distributed to streaming servers after approval. Set to false if you want to call the Distribute File API manually instead.Response
string
Human-readable status of the upload request (e.g.,
"Build queued for processing").string
Unique identifier of the uploaded build. Use it later with the Distribute File API or to correlate webhook events.
What happens after upload
1
Build Manager downloads the file
Streampixel pulls the
.zip from your fileUrl.2
Validation
The system verifies the archive is accessible and properly structured.
3
Linked to project
On success, the build is attached to your project and becomes ready to distribute.
Track each stage of the pipeline via webhooks — listen for
build.downloading, build.extracting, build.saving, and build.approved events.Confirming success
- Sign in to the dashboard.
- Open your project’s detail page.
- The new build appears in the build list with its current processing status.
Next steps
Distribute the build
Push an approved build to streaming servers (only needed when
autoRelease: false).Listen for webhooks
Get notified when builds are approved, rejected, or distributed.