Skip to main content

Documentation Index

Fetch the complete documentation index at: https://buildpixel.mintlify.app/llms.txt

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

If you have your own system that should receive new builds — a custom pixel-streaming runtime, a CDN, an internal artifact registry — set autoDeploy: true and point uploadBuildUrl at it.

​
Configuration

{
  "autoDeploy": true,
  "uploadBuildUrl": "https://deploy.studio.com/builds/upload",
  "uploadBuildAuthHeader": "Bearer dt_..."
}
When the build completes successfully, BuildPixel POSTs the artifact to your URL.

​
What gets sent

POST /builds/upload HTTP/1.1
Host: deploy.studio.com
Authorization: Bearer dt_...
Content-Type: multipart/form-data; boundary=...

--boundary
Content-Disposition: form-data; name="metadata"
Content-Type: application/json

{
  "buildId": "...",
  "projectId": "...",
  "platform": "Win64",
  "buildType": "Development",
  "ueVersion": "5.4",
  "branch": "main",
  "commit": "a1b2c3..."
}
--boundary
Content-Disposition: form-data; name="artifact"; filename="<buildId>.tar.gz"
Content-Type: application/gzip

<binary tarball bytes>
--boundary--
Two parts: a JSON metadata blob and the artifact tarball.

​
Receiver examples

@app.route("/builds/upload", methods=["POST"])
def upload_build():
    metadata = json.loads(request.form["metadata"])
    artifact = request.files["artifact"]

    artifact.save(f"/srv/builds/{metadata['buildId']}.tar.gz")
    subprocess.run([
        "tar", "-xzf", f"/srv/builds/{metadata['buildId']}.tar.gz",
        "-C", "/srv/runtime/staging"
    ])

    runtime.deploy(metadata["buildId"])
    return "", 204

​
If your endpoint fails

Failures don’t fail the build — the artifact is still uploaded to BuildPixel storage and downloadable from the dashboard. The build’s autoDeployStatus records whether the deploy succeeded.

​
StreamPixel uses this same mechanism

The StreamPixel integration is just a custom deploy with StreamPixel’s URL plugged in. You can use the same approach to wire up any system that accepts a multipart upload.