curl "https://platform.streampixel.io/api/v1/projects/664f1a2b3c4d5e6f7a8b9c0d?userId=663d0a1b2c3e4f5a6b7c8d9e" \
-H "x-api-key: $STREAMPIXEL_API_KEY"
const url = new URL('https://platform.streampixel.io/api/v1/projects/664f1a2b3c4d5e6f7a8b9c0d');
url.searchParams.set('userId', process.env.STREAMPIXEL_USER_ID);
const project = await (await fetch(url, { headers: { 'x-api-key': process.env.STREAMPIXEL_API_KEY } })).json();
console.log(project.name, project.status ? 'on' : 'off', project.region);
import os, requests
r = requests.get(
"https://platform.streampixel.io/api/v1/projects/664f1a2b3c4d5e6f7a8b9c0d",
params={"userId": os.environ["STREAMPIXEL_USER_ID"]},
headers={"x-api-key": os.environ["STREAMPIXEL_API_KEY"]},
)
project = r.json()
{
"_id": "664f1a2b3c4d5e6f7a8b9c0d",
"name": "Showroom",
"region": "Europe",
"status": true,
"subscriptionStatus": "active",
"allowedUsers": 4,
"appName": "665a2b3c4d5e6f7a8b9c0e1f",
"resX": 1920,
"resY": 1080,
"primaryCodec": "H264",
"fallbaCodec": "VP8",
"minBitrate": 2000,
"startBitrate": 6000,
"maxBitrate": 12000,
"maxRunTime": 30,
"afktimeout": 120,
"accessMode": "public",
"validPathUrl": ["app.example.com"],
"autoRelease": true,
"webhookUrl": "https://ci.example.com/hooks/streampixel",
"webhookEvents": ["build.approved", "build.rejected"],
"files": [
{ "_id": "665a2b3c4d5e6f7a8b9c0e1f", "status": "Approved", "date": "2026-09-20T15:02:11.000Z", "appPath": "665a2b3c4d5e6f7a8b9c0e1f", "unrealVersion": "5.4", "psVersion": 2 }
],
"createdAt": "2026-05-02T10:14:52.000Z"
}
Get Project
One project’s settings, builds and state.
GET
/
api
/
v1
/
projects
/
{projectId}
curl "https://platform.streampixel.io/api/v1/projects/664f1a2b3c4d5e6f7a8b9c0d?userId=663d0a1b2c3e4f5a6b7c8d9e" \
-H "x-api-key: $STREAMPIXEL_API_KEY"
const url = new URL('https://platform.streampixel.io/api/v1/projects/664f1a2b3c4d5e6f7a8b9c0d');
url.searchParams.set('userId', process.env.STREAMPIXEL_USER_ID);
const project = await (await fetch(url, { headers: { 'x-api-key': process.env.STREAMPIXEL_API_KEY } })).json();
console.log(project.name, project.status ? 'on' : 'off', project.region);
import os, requests
r = requests.get(
"https://platform.streampixel.io/api/v1/projects/664f1a2b3c4d5e6f7a8b9c0d",
params={"userId": os.environ["STREAMPIXEL_USER_ID"]},
headers={"x-api-key": os.environ["STREAMPIXEL_API_KEY"]},
)
project = r.json()
{
"_id": "664f1a2b3c4d5e6f7a8b9c0d",
"name": "Showroom",
"region": "Europe",
"status": true,
"subscriptionStatus": "active",
"allowedUsers": 4,
"appName": "665a2b3c4d5e6f7a8b9c0e1f",
"resX": 1920,
"resY": 1080,
"primaryCodec": "H264",
"fallbaCodec": "VP8",
"minBitrate": 2000,
"startBitrate": 6000,
"maxBitrate": 12000,
"maxRunTime": 30,
"afktimeout": 120,
"accessMode": "public",
"validPathUrl": ["app.example.com"],
"autoRelease": true,
"webhookUrl": "https://ci.example.com/hooks/streampixel",
"webhookEvents": ["build.approved", "build.rejected"],
"files": [
{ "_id": "665a2b3c4d5e6f7a8b9c0e1f", "status": "Approved", "date": "2026-09-20T15:02:11.000Z", "appPath": "665a2b3c4d5e6f7a8b9c0e1f", "unrealVersion": "5.4", "psVersion": 2 }
],
"createdAt": "2026-05-02T10:14:52.000Z"
}
Return one project in full: streaming settings, session rules, access mode, allowed domains, webhook configuration and the list of uploaded builds. Use List Builds when you only need the builds, and Update Project Settings to change what you read here.
Scope:
read. This endpoint predates the current API and still requires your own userId as a query parameter. Any other value is refused with 403.Path parameters
string
required
The project to fetch.
Query parameters
string
required
Your account’s user id. See Finding your IDs.
Headers
string
required
Your Streampixel API key.
Response
The project document. The fields below are the ones integrations rely on; others may appear.string
Project id.
string
Project name.
string
US-East-1, Europe, Asia Pacific or Australia.boolean
true when the project is on and admitting viewers.string
The project’s plan state.
number
Concurrent viewers the project may run.
string
Folder name of the build currently served; matches a build’s
appPath.number
Render resolution.
string
Video codecs.
number
kbps.
number
Maximum session length in minutes.
number
Inactivity timeout in seconds.
string
public, password, sso or programmatic.string[]
Domains allowed to embed the player. Empty means any.
boolean
Whether processed builds are distributed automatically.
string / string[]
Webhook configuration.
array
Uploaded builds:
_id, status, date, url, appPath, unrealVersion, psVersion, objection, statusUpdatedAt.string
ISO 8601.
curl "https://platform.streampixel.io/api/v1/projects/664f1a2b3c4d5e6f7a8b9c0d?userId=663d0a1b2c3e4f5a6b7c8d9e" \
-H "x-api-key: $STREAMPIXEL_API_KEY"
const url = new URL('https://platform.streampixel.io/api/v1/projects/664f1a2b3c4d5e6f7a8b9c0d');
url.searchParams.set('userId', process.env.STREAMPIXEL_USER_ID);
const project = await (await fetch(url, { headers: { 'x-api-key': process.env.STREAMPIXEL_API_KEY } })).json();
console.log(project.name, project.status ? 'on' : 'off', project.region);
import os, requests
r = requests.get(
"https://platform.streampixel.io/api/v1/projects/664f1a2b3c4d5e6f7a8b9c0d",
params={"userId": os.environ["STREAMPIXEL_USER_ID"]},
headers={"x-api-key": os.environ["STREAMPIXEL_API_KEY"]},
)
project = r.json()
{
"_id": "664f1a2b3c4d5e6f7a8b9c0d",
"name": "Showroom",
"region": "Europe",
"status": true,
"subscriptionStatus": "active",
"allowedUsers": 4,
"appName": "665a2b3c4d5e6f7a8b9c0e1f",
"resX": 1920,
"resY": 1080,
"primaryCodec": "H264",
"fallbaCodec": "VP8",
"minBitrate": 2000,
"startBitrate": 6000,
"maxBitrate": 12000,
"maxRunTime": 30,
"afktimeout": 120,
"accessMode": "public",
"validPathUrl": ["app.example.com"],
"autoRelease": true,
"webhookUrl": "https://ci.example.com/hooks/streampixel",
"webhookEvents": ["build.approved", "build.rejected"],
"files": [
{ "_id": "665a2b3c4d5e6f7a8b9c0e1f", "status": "Approved", "date": "2026-09-20T15:02:11.000Z", "appPath": "665a2b3c4d5e6f7a8b9c0e1f", "unrealVersion": "5.4", "psVersion": 2 }
],
"createdAt": "2026-05-02T10:14:52.000Z"
}
Errors
| Status | Cause |
|---|---|
400 | userId missing. |
403 | userId is not the key’s account, or the project belongs to another account. |
404 | No project with that id. |