Studio
Studio
Learn about the API

Use the ScreenWay Studio REST API.

The public API is organized around workspace API keys and /api/v1 REST endpoints. Use it to automate screens, media, programs, apps, Designer projects, notifications, and analytics.

Authentication

Create an API key in Studio under Settings → API Keys. Keys start with swk_, are shown once, and can be scoped to a workspace, spaces, groups, or individual screens.

request
curl https://studio.screenway.com/api/v1/screens \
  -H "Authorization: Bearer swk_your_api_key_here"

Bearer token

Send every request with Authorization: Bearer swk_....

Target scope

Notification delivery respects the targets configured on the key.

Workspace scoped

API routes resolve data only inside the key's workspace.

Response format

List endpoints return data plus meta. Pagination uses limit and offset;limit is capped at 200.

response
{
  "data": [{ "id": "screen_uuid", "name": "Lobby", "status": "online" }],
  "meta": { "total": 1, "limit": 50, "offset": 0 }
}

Endpoint map

GET/api/v1/screensList screens, filter by space_id and status.
GET/api/v1/screens/{id}Read screen details and current state.
POST/api/v1/screens/{id}/commandsRestart, reload, jump playback, or send content commands.
GET/POST/api/v1/mediaList or upload workspace media.
POST/api/v1/media/from-urlImport public media by URL.
POST/api/v1/media/from-dataUpload a data URL or base64 payload.
GET/POST/api/v1/foldersList, create, or reuse media folders.
GET/api/v1/programsList workspace programs.
POST/api/v1/programs/{id}/assignAssign a program to one or more screens.
GET/api/v1/appsList available ScreenWay apps.
GET/POST/api/v1/app-instancesList or create configured app instances.
GET/POST/api/v1/designer-projectsList or create Designer projects.
POST/api/v1/designer-projects/{id}/renderRender a Designer project to a PNG or JPEG data URL.
POST/api/v1/notificationsSend notifications to screens, spaces, groups, or workspace targets.
GET/api/v1/analyticsGet workspace analytics for a date range.

Common workflows

Media automation

Import files from URLs or data URLs, organize folders, then use media IDs in content workflows.

Playback control

Assign a program to screens or send a direct screen command for operational tasks.

Notifications

Push time-sensitive overlays to default API-key targets or explicit targets in the request.

Analytics

Pull workspace and per-screen analytics for reporting or monitoring.
notification
curl -X POST https://studio.screenway.com/api/v1/notifications \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer swk_your_api_key_here" \
  -d '{
    "title": "Service desk",
    "message": "Counter 4 is now open",
    "category": "INFO",
    "priority": "NORMAL"
  }'