API

Base URL

https://simplystream.com/api/v1

The full OpenAPI description is at https://simplystream.com/api/v1/openapi.json, and the interactive API docs let you try each call from the browser.

Your API key

Every account has one API key. It is shown as API Key on your Profile page. The key belongs to your account, so it can reach every project you can.

Send it as a bearer token on every request:

curl https://simplystream.com/api/v1/projects \
  -H "Authorization: Bearer $SIMPLYSTREAM_API_KEY"

A missing or wrong key gets 401 and this body:

{ "success": false, "error": "Unauthorized - missing or invalid Authorization header" }

Keeping the key safe

The key gives full access to your account through the API. Keep it out of source control and out of anything that runs in a player's browser. Call the API from your own server or tools, and read the key from an environment variable as the examples here do.

The examples assume your key is in SIMPLYSTREAM_API_KEY. Responses are JSON with a success field; the data sits in result or results, depending on the endpoint.

List your projects

curl https://simplystream.com/api/v1/projects \
  -H "Authorization: Bearer $SIMPLYSTREAM_API_KEY"

const res = await fetch('https://simplystream.com/api/v1/projects', {
	headers: { Authorization: `Bearer ${process.env.SIMPLYSTREAM_API_KEY}` },
});
const { result } = await res.json();
for (const project of result) console.log(project.id, project.name);

import os, requests

res = requests.get(
    'https://simplystream.com/api/v1/projects',
    headers={'Authorization': f'Bearer {os.environ["SIMPLYSTREAM_API_KEY"]}'},
)
for project in res.json()['result']:
    print(project['id'], project['name'])

List a project's revisions

Each build of a project is a numbered revision.

curl https://simplystream.com/api/v1/projects/PROJECT_ID/revisions \
  -H "Authorization: Bearer $SIMPLYSTREAM_API_KEY"

The response is { "success": true, "result": [ ... ] }, one entry per revision with its rev number.

Recent sessions

curl "https://simplystream.com/api/v1/sessions?project_id=PROJECT_ID" \
  -H "Authorization: Bearer $SIMPLYSTREAM_API_KEY"

The list is in results. Each session carries its revision, browser, device and status.

Concurrent users over time

curl "https://simplystream.com/api/v1/analytics/concurrent-users?project_id=PROJECT_ID&time_window_hours=24" \
  -H "Authorization: Bearer $SIMPLYSTREAM_API_KEY"

results is a list of { "timestamp": "...", "users": 3 } points. bucket_interval_hours sets the bucket size.

Session quality

curl "https://simplystream.com/api/v1/analytics/quality-stats?project_id=PROJECT_ID" \
  -H "Authorization: Bearer $SIMPLYSTREAM_API_KEY"

stats holds total_sessions, avg_fps, avg_latency_ms, avg_packet_loss_percent and quality_score.

Set a streaming nameserver for a project

Create the nameserver, then point the project at it. See Connect a domain for what nameservers do.

curl -X POST https://simplystream.com/api/v1/nameservers \
  -H "Authorization: Bearer $SIMPLYSTREAM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"route": "stream.example.com", "name": "Production"}'

The response's result holds the new nameserver's id and the nsRecords to add at your DNS provider. Then:

curl -X PUT https://simplystream.com/api/v1/projects/PROJECT_ID/nameserver \
  -H "Authorization: Bearer $SIMPLYSTREAM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"nameserverId": "NAMESERVER_ID"}'

Send {"nameserverId": null} to go back to the default.

Paths are relative to https://simplystream.com/api/v1. Every request needs Authorization: Bearer <your API key>. This page lists the endpoints most integrations use; the interactive API docs and https://simplystream.com/api/v1/openapi.json describe every endpoint with its full request and response schema, multiplayer included.

Response format

Responses are JSON. A successful call has "success": true and its data in result (one object, or a list on some endpoints) or results (a list). A failed call has "success": false and a message in error; a few session endpoints use msg instead.

Projects

Revisions

This API has no upload endpoint: new revisions come from Strata.

Play URLs

The API calls play URLs endpoints.

Sessions

Analytics

Nameservers

Server profiles

Server profiles apply to cloud streaming and hybrid sessions only.

Billing