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.

Once a build flips to complete, you have an artifact. There are two ways to grab it.

From the dashboard

Open the build in the dashboard and click Download. Your browser downloads a tarball:
mygame-build-<buildId>.tar.gz
└── MyGame/
    ├── MyGame.exe
    ├── Engine/
    └── MyGame/
        ├── Binaries/Win64/
        ├── Content/Paks/
        └── Plugins/
Extract, run, done.

Via the API

curl https://api.buildpixel.io/builds/$BUILD_ID/download \
  -H "Authorization: Bearer $TOKEN"
Returns a signed URL:
{
  "url": "https://...",
  "expiresAt": "...",
  "sizeBytes": 4823482910,
  "checksumMd5": "a1b2c3..."
}
The URL is good for 24 hours. After that, request a new one. For pipelines that pull builds:
URL=$(curl -s https://api.buildpixel.io/builds/$BUILD_ID/download \
  -H "Authorization: Bearer $TOKEN" | jq -r .url)

curl -fL "$URL" -o build.tar.gz

Listing artifacts for a project

curl "https://api.buildpixel.io/projects/$PROJECT_ID/artifacts?limit=100" \
  -H "Authorization: Bearer $TOKEN"
Useful for building your own tooling or pulling a specific past build by branch / commit.

Skip the download

If you’re shipping via pixel streaming, you don’t need to download anything — BuildPixel pushes the build straight into your runtime. See StreamPixel integration. For other deploy targets, see Custom deploy.