Skip to main content
POST
/
pixelStripeApi
/
projects
/
upload-file
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]",
    "fileUrl": "[PUBLIC_FILE_URL]",
    "projectId": "[YOUR_PROJECT_ID]",
    "autoRelease": true
  }'

{
  "message": "Build queued for processing",
  "uploadId": "665a2b3c4d5e6f7a8b9c0e1f"
}

Documentation Index

Fetch the complete documentation index at: https://docs.streampixel.io/llms.txt

Use this file to discover all available pages before exploring further.

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

RequirementWhere to get it
API KeyAPI authentication
User IDFinding your IDs
Project IDFinding your IDs
File URLYour cloud storage (see requirements below)

​
File URL requirements

The fileUrl must be a direct download link. The moment Streampixel accesses it, the .zip download must begin — no login pages, redirects, HTML wrappers, or download buttons.
Supported hosting:
  • AWS S3 (signed or public URL)
  • Google Cloud Storage
  • DigitalOcean Spaces
  • Any HTTP-accessible file server
URL
✅ Validhttps://your-bucket.s3.amazonaws.com/MyBuild.zip
❌ Invalidhttps://drive.google.com/file/d/abc123/view

​
Request body

​
apiKey
string
required
Your Streampixel API key. See API authentication.
​
userId
string
required
The ID of the account that owns the project.
​
projectId
string
required
The project to upload the build to.
​
fileUrl
string
required
Public direct-download URL of the .zip build file.
​
autoRelease
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

​
message
string
Human-readable status of the upload request (e.g., "Build queued for processing").
​
uploadId
string
Unique identifier of the uploaded build. Use it later with the Distribute File API or to correlate webhook events.
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]",
    "fileUrl": "[PUBLIC_FILE_URL]",
    "projectId": "[YOUR_PROJECT_ID]",
    "autoRelease": true
  }'

{
  "message": "Build queued for processing",
  "uploadId": "665a2b3c4d5e6f7a8b9c0e1f"
}

​
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.