Developers

Commons exposes a clean domain model—Organizations, Locations, Displays, Reels, Slides, Assets—and a new one-shot ad API to help you integrate signage experiences into your applications.

Organizations & Locations

Organizations: top-level tenants. Manage users, invitations, and quotas.
Locations: physical spaces. Include address, operating hours, and geocoordinates.
Displays: screens at a location. Each display plays exactly one reel.

Key endpoints (REST + JSON):
GET /api/organizations, GET /api/locations?organization_id=, POST /api/displays

Reels & Slides

Reels: ordered playlists attached to a display.
Slides: templated or custom HTML fragments, linked to assets.
Assets: media uploads (images, video) with optional tags.

Endpoints:
GET /api/reels?display_id=, POST /api/slides, POST /api/assets

One-shot ad API

Create review-ready slides from a single prompt. The API returns HTML formatted for a 2:1 canvas (ideal for landscape displays). You can schedule the generated slide inside a reel or present it for human approval.

Endpoint

POST /api/ads/oneshot
Content-Type: application/json
{"prompt": "Grand opening this Saturday with live music and late-night menu."}

Response includes: html, ratio, and original prompt. Use the HTML directly in a slide or map it into your templating system.

Admins can test prompts interactively at /admin/oneshot, which is a lightweight interface built atop this endpoint.