The Streampixel REST API lets you automate build management and integrate Streampixel into your CI/CD pipelines, internal tools, or custom platforms.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.
Base URL
Authentication
All API requests require an API key passed in the request body. See the authentication guide for setup.Before making API calls you’ll need three things from your dashboard: an API key, your user ID, and a project ID.
API authentication
Generate an API key and pass it on every request.
Finding your IDs
Locate your user ID and project ID in the dashboard.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
POST | /projects/upload-file | Upload a packaged UE build (.zip) to a project |
POST | /projects/distribute-file | Distribute an uploaded build to streaming servers |
Upload File API
Submit a build by URL. Used by CI pipelines and the Unreal plugin.
Distribute File API
Push an uploaded build to streaming servers. Only needed when
autoRelease: false.Events
Webhooks
Receive HTTP notifications when uploads, approvals, and distributions happen.
Typical workflow
Upload a build
Call the Upload File API with
autoRelease: true.Wait for approval
Listen via webhooks for
build.approved.When
autoRelease is true (the default), distribution happens automatically after approval. You don’t need to call the Distribute API.When to use the Distribute File API
- You uploaded with
autoRelease: falseand want to release the build manually. - You want to re-distribute a previous build (e.g., rolling back to an older version).
Rate limits
| Endpoint | Limit |
|---|---|
/projects/distribute-file | 1 request per 2 minutes per user |
Error format
All error responses return a JSON object with amessage field:
| Code | Meaning |
|---|---|
200 | Success |
400 | Bad request — missing or invalid parameters |
401 | Unauthorized — invalid API key or user ID |
403 | Forbidden — access denied to the resource |
404 | Not found — project or file doesn’t exist |
429 | Rate limit exceeded |
500 | Internal server error |