Skip to main content
The REST API gives scripts, CI pipelines and internal tools the same control over your projects that the dashboard has: publish builds and watch them move through the pipeline, switch projects on and off, change streaming settings, and read sessions, viewer telemetry, Unreal logs and analytics.

​
Base URL

All endpoints are HTTPS only and speak JSON. Timestamps are ISO 8601 in UTC. Ids are 24-character hexadecimal strings, except session ids, which look like session_1790294409382_3035.

​
Authentication in one line

Send your API key in the x-api-key header on every request. Keys are issued per account with scopes that say what they may do: upload, read, control. See API authentication.

​
Endpoints

​
Projects

​
Builds

​
Project control

​
Sessions and analytics

​
Webhooks and assistants

​
Typical workflows

1

Upload

Upload File with autoRelease: true; keep the uploadId.
2

Watch the pipeline

Poll Build Status every 30 seconds until state is live, or listen for build.approved on your webhook. The verdict tells you if a wait is genuine or the build is stuck.
3

Roll viewers over

Optionally End Sessions so everyone reconnects onto the new build.

​
Versioning and compatibility

  • Everything lives under /api/v1. Fields are added, never removed or renamed, within v1; treat unknown fields as ignorable.
  • The legacy prefix /pixelStripeApi still routes to the same handlers but answers with a Deprecation: true header. Use /api/v1 in new integrations.
  • The code field on error responses is stable and safe to branch on; message is for humans and may change.

​
OpenAPI

A machine-readable description of every endpoint on this page is in the docs repository as api-reference-openapi.json. Import it into Postman, Insomnia or an SDK generator.