API keys

API keys authenticate your REST API requests. A key is issued per user, inherits that user’s project access and team role, and carries scopes that say what it may do. Send it in the x-api-key header.

Generate a key

Open dashboard.streampixel.io and sign in.

Open your account menu

Click your account name in the top-right corner.

Choose scopes

Tick the scopes the key should have. Upload and Read are on by default; Control is off and shows a warning, because a control key can take projects offline and end viewers’ sessions.

Request the key

Click Request API Key. The key is emailed to your registered address and shown once, with its scopes.

Copy and store it

Save it in a password manager or secrets store immediately.

An API key is shown only once. If you lose it, generate a new one; the original cannot be retrieved.

Scopes

Scope	What the key may do
`upload`	Publish and re-distribute builds.
`read`	Read projects, build pipeline state, sessions, telemetry, Unreal logs and analytics.
`control`	Switch projects on and off, end sessions, choose the active build, change streaming settings.

Scopes are chosen when you request the key and shown under Current key afterwards. They cannot be changed on an existing key: issue a new one with the scopes you need, which replaces the old key.

Use a key in a request

curl https://platform.streampixel.io/api/v1/projects/projects-status \
  -H "x-api-key: YOUR_API_KEY"

const res = await fetch('https://platform.streampixel.io/api/v1/projects/projects-status', {
  headers: { 'x-api-key': process.env.STREAMPIXEL_API_KEY },
});

import os, requests

requests.get(
    'https://platform.streampixel.io/api/v1/projects/projects-status',
    headers={'x-api-key': os.environ['STREAMPIXEL_API_KEY']},
)

The two original build endpoints, Upload File and Distribute File, also accept apiKey in the JSON body; see their pages.

Team members and keys

A key can do no more than the person it belongs to:

Role	Key can
Owner, Admin, Editor	Everything its scopes allow, on the projects the member can see.
Uploader	Upload and read, plus Set Active Build with the `control` scope; the other control endpoints (enable, disable, end sessions, settings) are refused.
Viewer	Read only.
Finance	Nothing on the API.

If a member is removed from the team, their key stops working on that account’s projects immediately.

Rotate a key

Requesting a new key invalidates the previous one at once.

Generate a new key

Click Request API Key in your account menu.

Update your integrations

Replace the old key everywhere it is used: environment variables, CI secrets, deploy configs.

Verify

Make a test request. A 401 means an integration still references the old value.

Security best practices

Never commit keys to source control. Use environment variables or a secrets store.
Server-side only. Do not embed keys in browser bundles, mobile binaries or anything users can decompile.
Narrowest scopes. A CI pipeline needs upload and read; give control only to the automation that switches projects.
Rotate on suspected exposure. Pushed to a public repository by accident: rotate first, then scrub the commit.

Troubleshooting

Status	`code` / message	Cause
`401`	`Authentication required`	Header missing, key rotated, or key mistyped.
`403`	`API_KEY_SCOPE`	The key was issued without the scope this endpoint needs. Issue a new key with it.
`403`	`Access denied`	The project belongs to another account, or your team role does not allow the action.

Account

Project

Project settings

Built-in features

Cloud builds

Runtime Asset Storage

Unreal Engine extras

Generate a key

Scopes

Use a key in a request

Team members and keys

Rotate a key

Security best practices

Troubleshooting

​Generate a key

​Scopes

​Use a key in a request

​Team members and keys

​Rotate a key

​Security best practices

​Troubleshooting

Generate a key

Scopes

Use a key in a request

Team members and keys

Rotate a key

Security best practices

Troubleshooting