The REST API lets you automate uploads, distribution, and project management — for CI/CD pipelines, internal tools, and custom integrations.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
What you’ll need
| Where | |
|---|---|
| API key | Dashboard → Settings → API Key |
| User ID | Dashboard URL or Find your IDs |
| Project ID | Same — find both in your dashboard |
Pages in this section
Getting started
| API authentication | How to pass your key on every request. |
| Finding your IDs | Locate user ID and project ID in the dashboard. |
| Rate limits & errors | Limits per endpoint and error response format. |
Endpoints
| Method | Endpoint | What it does |
|---|---|---|
POST | /projects/upload-file | Upload a build by public URL. |
POST | /projects/distribute-file | Manually release a build (when autoRelease: false). |
GET | /projects | List all your projects. |
GET | /projects/userStats/{projectId} | Live + queued user counts for a project. |
Webhooks
| Webhooks | Receive HTTP notifications for uploads, approvals, and distribution. |
| Webhook events | Full event reference and payload schemas. |
Typical workflow
Upload a build
Call Upload File with
autoRelease: true.Wait for approval
Listen on your webhook for
build.approved.