Upload File API

Upload a build file

post

Upload a new build file to a Streampixel project by providing a publicly accessible direct URL to a .zip file. The file will be downloaded, extracted, scanned, and saved to the project.

Body

apiKeystringRequired

Your API authentication key

userIdstringRequired

Your Streampixel user ID

projectIdstringRequired

Project ID to link the build to

fileUrlstring · uriRequired

Publicly accessible direct URL to the .zip file. Must end with .zip and have no query strings.

autoReleasebooleanOptional

Whether to auto-release the new build after upload

Default: true

Responses

200

File uploaded successfully

application/json

400

Bad request — invalid URL format or missing fields

application/json

401

Unauthorized — invalid API key or user ID

application/json

post

/projects/upload-file

POST /pixelStripeApi/projects/upload-file HTTP/1.1
Host: api.streampixel.io
Content-Type: application/json
Accept: */*
Content-Length: 172

{
  "apiKey": "your-api-key",
  "userId": "664f1a2b3c4d5e6f7a8b9c0d",
  "projectId": "664f1a2b3c4d5e6f7a8b9c0d",
  "fileUrl": "https://storage.example.com/my-build.zip",
  "autoRelease": true
}

{
  "success": true,
  "uploadId": "665a2b3c4d5e6f7a8b9c0e1f",
  "message": "File uploaded successfully"
}

Overview

Upload a packaged Unreal Engine build (.zip) to your Streampixel project by providing a publicly accessible download URL. This API is used by CI/CD pipelines, automation tools, and the official Unreal Plugin.

Typical Workflow

Build your Unreal Engine project
Package it into a .zip file
Upload the .zip to your own cloud storage (S3, GCS, etc.)
Call this API with the public download link

Prerequisites

Before calling this endpoint, ensure you have:

Requirement

Where to Get It

API Key

API Authentication

User ID

Finding Your IDs

Project ID

Finding Your IDs

File URL

Your 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 immediately — 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

Examples:

URL

✅ Valid

https://your-bucket.s3.amazonaws.com/MyBuild.zip

❌ Invalid

https://drive.google.com/file/d/abc123/view

Code Examples

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
  }'

const axios = require('axios');

const response = await axios.post(
  'https://api.streampixel.io/pixelStripeApi/projects/upload-file',
  {
    apiKey: '[YOUR_API_KEY]',
    userId: '[YOUR_USER_ID]',
    fileUrl: '[PUBLIC_FILE_URL]',
    projectId: '[YOUR_PROJECT_ID]',
    autoRelease: false,
  }
);

console.log('Upload successful:', response.data);

import requests

response = requests.post(
    "https://api.streampixel.io/pixelStripeApi/projects/upload-file",
    json={
        "apiKey": "[YOUR_API_KEY]",
        "userId": "[YOUR_USER_ID]",
        "fileUrl": "[PUBLIC_FILE_URL]",
        "projectId": "[YOUR_PROJECT_ID]",
        "autoRelease": False,
    }
)

print("Upload successful:", response.json())

package main

import (
  "bytes"
  "encoding/json"
  "fmt"
  "net/http"
)

func main() {
  url := "https://api.streampixel.io/pixelStripeApi/projects/upload-file"

  data := map[string]interface{}{
    "apiKey":      "[YOUR_API_KEY]",
    "userId":      "[YOUR_USER_ID]",
    "fileUrl":     "[PUBLIC_FILE_URL]",
    "projectId":   "[YOUR_PROJECT_ID]",
    "autoRelease": false,
  }

  body, _ := json.Marshal(data)
  resp, err := http.Post(url, "application/json", bytes.NewBuffer(body))
  if err != nil {
    fmt.Println("Request failed:", err)
    return
  }
  defer resp.Body.Close()

  fmt.Println("Response status:", resp.Status)
}

import okhttp3.*;

public class UploadFile {
    public static void main(String[] args) throws Exception {
        OkHttpClient client = new OkHttpClient();

        MediaType mediaType = MediaType.parse("application/json");
        String jsonBody = "{"
            + "\"apiKey\":\"[YOUR_API_KEY]\","
            + "\"userId\":\"[YOUR_USER_ID]\","
            + "\"fileUrl\":\"[PUBLIC_FILE_URL]\","
            + "\"projectId\":\"[YOUR_PROJECT_ID]\","
            + "\"autoRelease\":false"
            + "}";

        RequestBody body = RequestBody.create(mediaType, jsonBody);
        Request request = new Request.Builder()
            .url("https://api.streampixel.io/pixelStripeApi/projects/upload-file")
            .post(body)
            .addHeader("Content-Type", "application/json")
            .build();

        Response response = client.newCall(request).execute();
        System.out.println(response.body().string());
    }
}

What Happens After Upload

Once your request is accepted:

The build is sent to the Build Manager Server for downloading and validation
The system verifies that the .zip is accessible and properly structured
If validation passes, the build is linked to your project

You can track each stage of this pipeline via Webhooks — listen for build.downloading, build.extracting, build.saving, and build.approved events.

Confirming Success

Verify your build was uploaded by:

Logging in to your Streampixel Dashboard
Navigating to your project's detail page
The uploaded build will appear in the build list, showing its processing status

PreviousFinding Your User & Project IDs NextDistribute File API

Last updated 8 hours ago

hashtagUpload a build file

hashtagOverview

hashtagTypical Workflow

hashtagPrerequisites

hashtagFile URL Requirements

hashtagCode Examples

hashtagWhat Happens After Upload

hashtagConfirming Success

Upload a build file

Overview

Typical Workflow

Prerequisites

File URL Requirements

Code Examples

What Happens After Upload

Confirming Success