OpenAPI YAMLOpenAPI JSONproblems YAML
Choose the right service
The endpoint determines both the base URL and the credential. The request templates below use the declared service URL.
| What you are doing | Service | Authentication |
|---|---|---|
| Managing screens and content | api.screenrig.ai | Agent bearer token |
| Running a Player | play.screenrig.ai | Browser cookies or native Player credentials |
| Managing a login and projects | screenrig.ai/dashboard | Dashboard cookies |
| Provisioning people from an identity provider | api.screenrig.ai/scim/v2 | Organization SCIM token |
| Loading an application release | Its exact host under apps.screenrig.ai | Launch ticket or release cookie |
Native Players use ScreenRig-Pairing during setup and ScreenRig-Session afterward. These requests must not include cookies. Browser endpoints use their own cookies.
Authentication names used below
- projectBearer
- The active agent token used by the bundled CLI, bound to exactly one project.
- capability areas
- Each agent credential carries a fixed set of areas:
screens,content,playlists,advertising,reports, andproject. A credential calls only routes in its areas;reportsalso reads any area. A request naming a missing area returns403 forbiddenwith detail "This agent credential lacks the <name> capability." Connect a new agent installation with the needed capabilities to recover. - revocableAgentBearer
- The calling agent token, accepted for retrying its own disconnection.
- pairing, device, and runtime cookies
- Browser Player credentials. Each endpoint specifies which cookie it accepts.
- dashboard session cookie
- The signed-in person's session and selected project. The separate
__Host-screenrig-signupcookie binds link-invitation signup, email verification, credential options, and acceptance. Neither cookie is an agent credential. A person who can approve creates and replaces playlists with it from the dashboard's page editor. - primitiveCapability
- Short-lived access to one application's key/value storage from a playlist primitive.
- demoSession
- A private website demo session, separate from project and dashboard credentials. The website sets it after intake or a private invitation; flow identifiers never authorize access.
- scimBearer
- An organization's SCIM provisioning token, accepted only by the
/scim/v2routes. It is never a project, agent, or dashboard credential. - ssoTransaction
- The cookie that binds a single sign-on sign-in to the browser that started it.
- operatorBearer
- Service operator access.
People, projects, and invitations
A person has one login and can belong to many projects. Enrollment always creates a new project and emails a project-member invitation to its contact address. The agent proposes a project name; each agent token remains bound to that project.
The dashboard lists the person's projects and switches the selected project for cookie-authenticated operations. Personal email and passkeys belong to the login, not the project.
Invitations share one create, list, revoke, and acceptance flow. Project members receive email by default; an explicitly requested member link is returned only to its creator. Ad-buyer invitations are email-only. Email invitations expire after seven days and member links after twenty-four hours. A new person creates a passkey; an existing person signs in before accepting. Link signup verifies the person's email before creating a login.
Sign-in reset is mailbox-only, expires after one hour, and replaces the person's sign-in credentials while revoking their other sessions. Request acknowledgment does not reveal whether an email has a login. Opening the dashboard is navigation, not a grant of authority.
Common request semantics
- Idempotency: when an endpoint accepts
Idempotency-Key, reuse that key and the identical request after a lost response; mismatch returns409 idempotency_mismatch. - Revisions: when an endpoint requires
If-Match, send the current resource revision; stale writes return412 revision_conflict. - Cursors: list and SSE cursors are opaque.
- Operations: uploads may begin in
receiving, then usequeued,running,succeeded,failed, orcancelled. - SSE: resume with the last cursor or
Last-Event-ID. Astream.resync_requiredframe means refetch authoritative state and resume at its supplied head cursor. - Limits: capabilities publish active limits; rate limiting returns
429 rate_limited.
Credential persistence belongs to the plugin flow. The bundled CLI reads platform configuration outside the replaceable plugin directory.
Upload lifecycles
Applications
Submit an already-built deterministic archive and wait for validation, extraction, and immutable publication. screenRIG handles packaged static output.
Media
Declare exact type, size, and hash; follow the signed raw PUT method and headers verbatim; commit and wait. Treat signed URLs and headers as credentials.
Runtime and protected content
Pairing, device/runtime sessions, manifests, reports, events, launch tickets, and runtime K/V live on the trusted Player origin. Manifest media supports contract-defined ranges; release assets use exact isolated hosts. Authorized native Player sessions receive normalized immutable webapp packages through the manifest-and-release-bound protected route.
Content follows current screen authority. Release, package, and K/V access derives from current screen-manifest grants; media is served to a screen whose project owns it. Native package authority binds the current screen, manifest revision, release identity, package hash, size, type, and device session; storage remains private and delivery remains server-mediated.
Complete endpoint inventory
749 operations in 41 groups, generated from api/openapi.yaml. Each group has its own page with every operation's parameters, request fields, request template and responses.
Service metadata, capabilities and documentation search
6 operations with their parameters, request templates and responses.
- Get Health
GET /.health - Get Readiness
GET /.ready - Get Version
GET /.version - Get Capabilities
GET /api/capabilities - Search the official documentation
GET /api/docs/search - Read an official documentation page or section
GET /api/docs/page
Projects, invitations, and sign-in
149 operations with their parameters, request templates and responses.
- Preview Project Deletion Agent
GET /api/project/deletion-preview - Transfer Project Owner Agent
PUT /api/project/owner - Move Project Agent
POST /api/project/move - Allowed Project Moves Agent
GET /api/project/moves - List Agent Projects
GET /api/projects - Create Agent Project
POST /api/projects - List Invitations
GET /api/invitations - Create Invitations
POST /api/invitations - Revoke Invitation
POST /api/invitations/{id}/revoke - Request Sign In Reset
POST /api/sign-in-resets - Enroll CLI
POST /api/enrollments - Start Agent IDSign In
GET /agentid/start - Complete Agent IDSign In
GET /agentid/callback - Get Project
GET /api/project - Update Project
PATCH /api/project - Delete Project Agent
DELETE /api/project - Get Project Capabilities
GET /api/project/capabilities - List Organization Audit
GET /api/organizations/{org_id}/audit - List Organization Notifications
GET /api/organizations/{org_id}/notifications - Create Organization Notification
POST /api/organizations/{org_id}/notifications - Get Organization Notification
GET /api/organizations/{org_id}/notifications/{id} - Update Organization Notification
PATCH /api/organizations/{org_id}/notifications/{id} - Delete Organization Notification
DELETE /api/organizations/{org_id}/notifications/{id} - Rotate Organization Notification Secret
POST /api/organizations/{org_id}/notifications/{id}/rotate-secret - Test Organization Notification
POST /api/organizations/{org_id}/notifications/{id}/test - List Organization Notification Deliveries
GET /api/organizations/{org_id}/notifications/{id}/deliveries - List Organization Notification Delivery Attempts
GET /api/organizations/{org_id}/notifications/{id}/deliveries/{delivery_id}/attempts - Resubscribe Organization Notification User
DELETE /api/organizations/{org_id}/notifications/{id}/unsubscribed/{user_id} - List Report Kinds In Project
GET /api/projects/{project_id}/reports - List Report Subscriptions In Project
GET /api/projects/{project_id}/report-subscriptions - Create Report Subscription In Project
POST /api/projects/{project_id}/report-subscriptions - List Cards In Project
GET /api/projects/{project_id}/cards - Create Project Card
POST /api/projects/{project_id}/cards - Create Organization Portal
POST /api/organizations/{org_id}/billing/portal-sessions - Set Organization Auto Top Up
PUT /api/organizations/{org_id}/billing/auto-top-up - Get Organization Payments
GET /api/organizations/{org_id}/billing/payments - Create Organization Checkout
POST /api/organizations/{org_id}/billing/credit-checkouts - Get Organization Billing Balance
GET /api/organizations/{org_id}/billing/balance - Get Organization Billing Statement
GET /api/organizations/{org_id}/billing/statement - Get Organization Billing Usage
GET /api/organizations/{org_id}/billing/usage - Agent Organizations List
GET /api/organizations - Agent Organizations Rename
PATCH /api/organizations/{org_id} - Set Project Review Policy
PUT /api/project/review-policy - Preview Project Deletion Agent In Project
GET /api/projects/{project_id}/project/deletion-preview - Transfer Project Owner Agent In Project
PUT /api/projects/{project_id}/project/owner - Move Project Agent In Project
POST /api/projects/{project_id}/project/move - Allowed Project Moves Agent In Project
GET /api/projects/{project_id}/project/moves - List Invitations In Project
GET /api/projects/{project_id}/invitations - Create Invitations In Project
POST /api/projects/{project_id}/invitations - Get Project In Project
GET /api/projects/{project_id}/project - Update Project In Project
PATCH /api/projects/{project_id}/project - Delete Project Agent In Project
DELETE /api/projects/{project_id}/project - List Applications In Project
GET /api/projects/{project_id}/applications - Upload Application In Project
POST /api/projects/{project_id}/applications - Create Application Upload In Project
POST /api/projects/{project_id}/applications/uploads - List Playlists V2 In Project
GET /api/projects/{project_id}/playlists - Create Playlist V2 In Project
POST /api/projects/{project_id}/playlists - List Screens In Project
GET /api/projects/{project_id}/screens - List Screen Folders In Project
GET /api/projects/{project_id}/screen-folders - Create Screen Folder In Project
POST /api/projects/{project_id}/screen-folders - Move Screens In Project
POST /api/projects/{project_id}/screens/move - Get Schedule Calendar In Project
GET /api/projects/{project_id}/schedule/calendar - Get Schedule Import Template In Project
GET /api/projects/{project_id}/schedule/imports/template - Preview Schedule Import In Project
POST /api/projects/{project_id}/schedule/imports/preview - Commit Schedule Import In Project
POST /api/projects/{project_id}/schedule/imports - Claim Browser Link In Project
POST /api/projects/{project_id}/project/browser-links/claim - Pair Screen In Project
POST /api/projects/{project_id}/screens/pair - Provision Screen In Project
POST /api/projects/{project_id}/screens/provision - Apply Screen Actions In Project
POST /api/projects/{project_id}/screens/actions - Start Tab Share In Project
POST /api/projects/{project_id}/tab-shares - List Campaigns In Project
GET /api/projects/{project_id}/campaigns - Create Campaign In Project
POST /api/projects/{project_id}/campaigns - List Connections In Project
GET /api/projects/{project_id}/connections - Create Connection In Project
POST /api/projects/{project_id}/connections - List BIConnections In Project
GET /api/projects/{project_id}/bi-connections - Create BIConnection In Project
POST /api/projects/{project_id}/bi-connections - List BIViews In Project
GET /api/projects/{project_id}/bi-views - Create BIView In Project
POST /api/projects/{project_id}/bi-views - List Triggers In Project
GET /api/projects/{project_id}/triggers - Create Trigger In Project
POST /api/projects/{project_id}/triggers - List Events In Project
GET /api/projects/{project_id}/events - Get Project Capabilities In Project
GET /api/projects/{project_id}/project/capabilities - Get Billing Balance In Project
GET /api/projects/{project_id}/billing/balance - Get Billing Statement In Project
GET /api/projects/{project_id}/billing/statement - Get Billing Usage In Project
GET /api/projects/{project_id}/billing/usage - Get Advertising Network In Project
GET /api/projects/{project_id}/advertising/network - Create Advertising Network In Project
POST /api/projects/{project_id}/advertising/network - Set Advertising Default Rate In Project
POST /api/projects/{project_id}/advertising/network/rate - List Advertising Inventory In Project
GET /api/projects/{project_id}/advertising/inventory - List Advertising Slots In Project
GET /api/projects/{project_id}/advertising/slots - Create Advertising Slot In Project
POST /api/projects/{project_id}/advertising/slots - List Advertising Memberships In Project
GET /api/projects/{project_id}/advertising/memberships - List Advertising Joined Networks In Project
GET /api/projects/{project_id}/advertising/networks - List Advertising Creatives In Project
GET /api/projects/{project_id}/advertising/creatives - Create Advertising Creative In Project
POST /api/projects/{project_id}/advertising/creatives - List Advertising Campaigns In Project
GET /api/projects/{project_id}/advertising/campaigns - Create Advertising Campaign In Project
POST /api/projects/{project_id}/advertising/campaigns - List Advertising Reviews In Project
GET /api/projects/{project_id}/advertising/reviews - Get Advertising Spend In Project
GET /api/projects/{project_id}/advertising/reports/spend - Get Advertising Delivery In Project
GET /api/projects/{project_id}/advertising/reports/delivery - List Playback Aggregates In Project
GET /api/projects/{project_id}/playback - List Playback Plays In Project
GET /api/projects/{project_id}/playback/plays - Get Playback Totals In Project
GET /api/projects/{project_id}/playback/totals - Get Playback Completeness In Project
GET /api/projects/{project_id}/playback/completeness - Get Health Trend In Project
GET /api/projects/{project_id}/health/trend - Get Project Uptime In Project
GET /api/projects/{project_id}/uptime/daily - List Card Types In Project
GET /api/projects/{project_id}/card-types - List Background Categories In Project
GET /api/projects/{project_id}/backgrounds/categories - List Background Sets In Project
GET /api/projects/{project_id}/backgrounds/sets - List Card Data In Project
GET /api/projects/{project_id}/card-data - List Media In Project
GET /api/projects/{project_id}/media - Create Media Generation In Project
POST /api/projects/{project_id}/media/generations - List Media Folders In Project
GET /api/projects/{project_id}/media-folders - Create Media Folder In Project
POST /api/projects/{project_id}/media-folders - Move Media In Project
POST /api/projects/{project_id}/media/move - Create Media Upload In Project
POST /api/projects/{project_id}/media/uploads - Preview Selector In Project
POST /api/projects/{project_id}/selectors/preview - List Bug Reports In Project
GET /api/projects/{project_id}/feedback/bugs - Report Bug In Project
POST /api/projects/{project_id}/feedback/bugs - List Feature Requests In Project
GET /api/projects/{project_id}/feedback/features - Request Feature In Project
POST /api/projects/{project_id}/feedback/features - List Service Clients In Project
GET /api/projects/{project_id}/service-clients - Create Service Client In Project
POST /api/projects/{project_id}/service-clients - List Media Sync Accounts In Project
GET /api/projects/{project_id}/media-sync-accounts - Create Media Sync Account In Project
POST /api/projects/{project_id}/media-sync-accounts - List Media Syncs In Project
GET /api/projects/{project_id}/media-syncs - Create Media Sync In Project
POST /api/projects/{project_id}/media-syncs - List Fleet Links In Project
GET /api/projects/{project_id}/fleet-links - Create Fleet Link In Project
POST /api/projects/{project_id}/fleet-links - List Webhooks In Project
GET /api/projects/{project_id}/webhooks - Create Webhook In Project
POST /api/projects/{project_id}/webhooks - List Alerts In Project
GET /api/projects/{project_id}/alerts - List Alert Mutes In Project
GET /api/projects/{project_id}/alert-mutes - Create Alert Mute In Project
POST /api/projects/{project_id}/alert-mutes - List Notifications In Project
GET /api/projects/{project_id}/notifications - Create Notification In Project
POST /api/projects/{project_id}/notifications - List Notes In Project
GET /api/projects/{project_id}/notes - Add Note In Project
POST /api/projects/{project_id}/notes - Support Status In Project
GET /api/projects/{project_id}/support/status - List Support Conversations In Project
GET /api/projects/{project_id}/support/conversations - Create Support Conversation In Project
POST /api/projects/{project_id}/support/conversations - List Reviews In Project
GET /api/projects/{project_id}/reviews - Project Scoped_get Card Data
GET /api/projects/{project_id}/card-data/{key} - Project Scoped_put Card Data
PUT /api/projects/{project_id}/card-data/{key} - Project Scoped_delete Card Data
DELETE /api/projects/{project_id}/card-data/{key} - Project Scoped_get Feed
GET /api/projects/{project_id}/feeds/{family} - Project Scoped_list Advertising Joined Inventory
GET /api/projects/{project_id}/advertising/networks/{seller_project_id}/inventory - Project Scoped_get Current Agent
GET /api/projects/{project_id}/agents/self - Project Scoped_disconnect Current Agent
POST /api/projects/{project_id}/agents/self/disconnect
Plans, credit balances and statements
6 operations with their parameters, request templates and responses.
- Get Billing Balance
GET /api/billing/balance - Get Billing Statement
GET /api/billing/statement - Get Billing Usage
GET /api/billing/usage - Get App Store Offer
GET /api/organizations/{organization_id}/app-store/offer - Record App Store Transaction
POST /api/organizations/{organization_id}/app-store/transactions - Receive App Store Notification
POST /api/app-store/notifications
Agent installations and connections
3 operations with their parameters, request templates and responses.
- Revoke Agent Identity
POST /api/agent-identity/revoke - Get Current Agent
GET /api/agents/self - Disconnect Current Agent
POST /api/agents/self/disconnect
OAuth sign-in, tokens and revocation
10 operations with their parameters, request templates and responses.
- Oauth Token
POST /oauth/token - Oauth Device Authorization
POST /oauth/device_authorization - Oauth Authorize
GET /oauth/authorize - Oauth Revoke
POST /oauth/revoke - Oauth Authorization Server Metadata
GET /.well-known/oauth-authorization-server - Oauth Protected Resource MCP
GET /.well-known/oauth-protected-resource/mcp - Oauth Protected Resource API
GET /.well-known/oauth-protected-resource/api - Get Dashboard OAuth Authorization
GET /api/oauth/authorizations/{id} - Approve Dashboard OAuth Authorization
POST /api/oauth/authorizations/{id}/approve - Deny Dashboard OAuth Authorization
POST /api/oauth/authorizations/{id}/deny
Single sign-on: sign-in routes, identity provider and policy
13 operations with their parameters, request templates and responses.
- Discover Dashboard SSO
POST /api/sso/discovery - Start Dashboard SSO
POST /api/sso/starts - Receive Dashboard SSOOIDCCallback
POST /api/sso/oidc/{connection_id}/callback - Get Dashboard SSOSAMLMetadata
GET /api/sso/saml/{connection_id} - Receive Dashboard SSOSAMLAssertion
POST /api/sso/saml/{connection_id}/acs - Finish Dashboard SSO
POST /api/sso/finish - Start Dashboard Session SSO
POST /api/session/sso-starts - Dashboard Organizations Get Identity Provider
GET /api/organizations/{org_id}/identity-provider - Dashboard Organizations Set Identity Provider
PUT /api/organizations/{org_id}/identity-provider - Dashboard Organizations Remove Identity Provider
DELETE /api/organizations/{org_id}/identity-provider - Dashboard Organizations Test Identity Provider
POST /api/organizations/{org_id}/identity-provider/tests - Dashboard Organizations Set SSOPolicy
PUT /api/organizations/{org_id}/sso-policy - Dashboard Organizations Cancel SSORemoval
DELETE /api/organizations/{org_id}/sso-policy/removal
User provisioning: SCIM 2.0, tokens and group bindings
24 operations with their parameters, request templates and responses.
- Dashboard Organizations Get SCIM
GET /api/organizations/{org_id}/scim - Dashboard Organizations Set SCIM
PUT /api/organizations/{org_id}/scim - Dashboard Organizations Create SCIMToken
POST /api/organizations/{org_id}/scim/tokens - Dashboard Organizations Revoke SCIMToken
DELETE /api/organizations/{org_id}/scim/tokens/{token_id} - Dashboard Organizations List SCIMGroups
GET /api/organizations/{org_id}/scim/groups - Dashboard Organizations List SCIMEvents
GET /api/organizations/{org_id}/scim/events - List Dashboard Group Bindings
GET /api/project/group-bindings - Create Dashboard Group Binding
POST /api/project/group-bindings - Delete Dashboard Group Binding
DELETE /api/project/group-bindings/{binding_id} - Get SCIMService Provider Config
GET /scim/v2/ServiceProviderConfig - List SCIMResource Types
GET /scim/v2/ResourceTypes - List SCIMSchemas
GET /scim/v2/Schemas - List SCIMUsers
GET /scim/v2/Users - Create SCIMUser
POST /scim/v2/Users - Get SCIMUser
GET /scim/v2/Users/{id} - Replace SCIMUser
PUT /scim/v2/Users/{id} - Patch SCIMUser
PATCH /scim/v2/Users/{id} - Delete SCIMUser
DELETE /scim/v2/Users/{id} - List SCIMGroups
GET /scim/v2/Groups - Create SCIMGroup
POST /scim/v2/Groups - Get SCIMGroup
GET /scim/v2/Groups/{id} - Replace SCIMGroup
PUT /scim/v2/Groups/{id} - Patch SCIMGroup
PATCH /scim/v2/Groups/{id} - Delete SCIMGroup
DELETE /scim/v2/Groups/{id}
Service clients
9 operations with their parameters, request templates and responses.
- List Service Clients
GET /api/service-clients - Create Service Client
POST /api/service-clients - Get Service Client
GET /api/service-clients/{id} - Update Service Client
PATCH /api/service-clients/{id} - Add Service Client Key
POST /api/service-clients/{id}/keys - Remove Service Client Key
POST /api/service-clients/{id}/keys/{kid}/remove - Add Service Client Secret
POST /api/service-clients/{id}/secrets - Remove Service Client Secret
POST /api/service-clients/{id}/secrets/{secret_id}/remove - Revoke Service Client
POST /api/service-clients/{id}/revoke
Applications and operations
11 operations with their parameters, request templates and responses.
- List Applications
GET /api/applications - Upload Application
POST /api/applications - Upload Application Release
POST /api/applications/{id}/releases - Create Application Upload
POST /api/applications/uploads - Create Application Release Upload
POST /api/applications/{id}/uploads - Commit Application Upload
POST /api/applications/uploads/{id}/commit - Get Application
GET /api/applications/{id} - Rename Application
PATCH /api/applications/{id} - Delete Application
DELETE /api/applications/{id} - Get Operation
GET /api/operations/{id} - Cancel Operation
POST /api/operations/{id}/cancel
Media uploads
43 operations with their parameters, request templates and responses.
- List Background Categories
GET /api/backgrounds/categories - List Background Sets
GET /api/backgrounds/sets - Get Background Set
GET /api/backgrounds/sets/{set_id} - Get Background
GET /api/backgrounds/{background_id} - List Media
GET /api/media - Create Media Generation
POST /api/media/generations - List Media Folders
GET /api/media-folders - Create Media Folder
POST /api/media-folders - Get Media Folder
GET /api/media-folders/{id} - Update Media Folder
PATCH /api/media-folders/{id} - Delete Media Folder
DELETE /api/media-folders/{id} - Move Media
POST /api/media/move - Create Media Upload
POST /api/media/uploads - Commit Media Upload
POST /api/media/uploads/{id}/commit - Preview Selector
POST /api/selectors/preview - Get Media
GET /api/media/{id} - Patch Media
PATCH /api/media/{id} - Delete Media
DELETE /api/media/{id} - Patch Media Tags
PATCH /api/media/{id}/tags - Patch Media Availability
PATCH /api/media/{id}/availability - Replace Media
POST /api/media/{id}/replace - List Media Versions
GET /api/media/{id}/versions - Delete Media Version
DELETE /api/media/{id}/versions/{version} - Restore Media Version
POST /api/media/{id}/versions/{version}/restore - Export Media Content
GET /api/media/{id}/content - Head Media Content
HEAD /api/media/{id}/content - List Media Sync Accounts
GET /api/media-sync-accounts - Create Media Sync Account
POST /api/media-sync-accounts - Get Media Sync Account
GET /api/media-sync-accounts/{id} - Update Media Sync Account
PATCH /api/media-sync-accounts/{id} - Delete Media Sync Account
DELETE /api/media-sync-accounts/{id} - Test Media Sync Account
POST /api/media-sync-accounts/{id}/test - Connect Media Sync Account
POST /api/media-sync-accounts/{id}/connect - List Media Sync Designs
GET /api/media-sync-accounts/{id}/designs - Complete Canva Consent
GET /api/canva/callback - Publish Canva Design
POST /api/canva/publishes - Complete Dropbox Consent
GET /api/dropbox/callback - List Media Syncs
GET /api/media-syncs - Create Media Sync
POST /api/media-syncs - Get Media Sync
GET /api/media-syncs/{id} - Update Media Sync
PATCH /api/media-syncs/{id} - Delete Media Sync
DELETE /api/media-syncs/{id} - Run Media Sync
POST /api/media-syncs/{id}/run
Playlists
16 operations with their parameters, request templates and responses.
- List Playlists V2
GET /api/playlists - Create Playlist V2
POST /api/playlists - Get Playlist V2
GET /api/playlists/{id} - Update Playlist V2
PUT /api/playlists/{id} - Patch Playlist
PATCH /api/playlists/{id} - Delete Playlist V2
DELETE /api/playlists/{id} - Patch Playlist Structure
PATCH /api/playlists/{id}/structure - List Playlist Revisions
GET /api/playlists/{id}/revisions - Get Playlist Revision
GET /api/playlists/{id}/revisions/{revision} - Promote Playlist Revision
POST /api/playlists/{id}/revisions/{revision}/promote - Update Playlist Values
PATCH /api/playlists/{id}/values - List Playlist Instances
GET /api/playlists/{id}/instances - Expand Playlist Template
POST /api/playlists/{id}/expand - Add Playlist Page
POST /api/playlists/{id}/pages - Replace Playlist Page
PUT /api/playlists/{id}/pages/{page_id} - Remove Playlist Page
DELETE /api/playlists/{id}/pages/{page_id}
Screens
86 operations with their parameters, request templates and responses.
- List Screens
GET /api/screens - List Screen Folders
GET /api/screen-folders - Create Screen Folder
POST /api/screen-folders - Get Screen Folder
GET /api/screen-folders/{id} - Update Screen Folder
PATCH /api/screen-folders/{id} - Delete Screen Folder
DELETE /api/screen-folders/{id} - Move Screens
POST /api/screens/move - Get Schedule Calendar
GET /api/schedule/calendar - Pair Screen
POST /api/screens/pair - Provision Screen
POST /api/screens/provision - Apply Screen Actions
POST /api/screens/actions - Get Screen
GET /api/screens/{id} - Update Screen
PATCH /api/screens/{id} - Delete Screen
DELETE /api/screens/{id} - Patch Screen Tags
PATCH /api/screens/{id}/tags - Patch Screen Fields
PATCH /api/screens/{id}/fields - Patch Screen Location
PATCH /api/screens/{id}/location - Patch Screen Verbosity
PATCH /api/screens/{id}/verbosity - Patch Screen Device Settings
PATCH /api/screens/{id}/device-settings - Patch Screen Name
PATCH /api/screens/{id}/name - Patch Screen Timezone
PATCH /api/screens/{id}/timezone - Patch Screen Playlist
PATCH /api/screens/{id}/playlist - Rotate Screen Public Id
POST /api/screens/{id}/public-id/rotate - Get Screen Link
GET /api/screens/{id}/link - Create Screen Link
POST /api/screens/{id}/link - Delete Screen Link
DELETE /api/screens/{id}/link - Confirm Screen Recovery
POST /api/screens/{id}/recovery/confirm - Replace Screen
POST /api/screens/{id}/replace - Archive Screen
POST /api/screens/{id}/archive - Unarchive Screen
POST /api/screens/{id}/unarchive - Reload Screen
POST /api/screens/{id}/reload - Get Screen Playlist Schedule
GET /api/screens/{id}/playlist-schedule - Set Screen Playlist Schedule
PUT /api/screens/{id}/playlist-schedule - Clear Screen Playlist Schedule
DELETE /api/screens/{id}/playlist-schedule - Preview Screen Playlist Schedule
POST /api/screens/{id}/playlist-schedule/preview - List Screen Playlist Schedule Revisions
GET /api/screens/{id}/playlist-schedule/revisions - Restore Screen Playlist Schedule Revision
POST /api/screens/{id}/playlist-schedule/revisions/{revision}/restore - Set Screen Takeover
POST /api/screens/{id}/takeover - Clear Screen Takeover
DELETE /api/screens/{id}/takeover - Start Tab Share
POST /api/tab-shares - Get Tab Share
GET /api/tab-shares/{id} - Stop Tab Share
DELETE /api/tab-shares/{id} - Play Screen Page
POST /api/screens/{id}/play-page - Identify Screen
POST /api/screens/{id}/identify - Suspend Screen
POST /api/screens/{id}/suspend - Resume Screen
POST /api/screens/{id}/resume - Reboot Screen
POST /api/screens/{id}/reboot - Clear Screen Cache
POST /api/screens/{id}/clear-cache - Restart Screen App
POST /api/screens/{id}/restart-app - Update Screen Player
POST /api/screens/{id}/update - List Screen Commands
GET /api/screens/{id}/commands - Cancel Screen Command
POST /api/screens/{id}/commands/{command_id}/cancel - Set Screen Display
POST /api/screens/{id}/display - Clear Screen Display
DELETE /api/screens/{id}/display - Set Screen Volume
POST /api/screens/{id}/volume - Get Screen Display Schedule
GET /api/screens/{id}/display-schedule - Set Screen Display Schedule
PUT /api/screens/{id}/display-schedule - Clear Screen Display Schedule
DELETE /api/screens/{id}/display-schedule - Get Screen Reboot Schedule
GET /api/screens/{id}/reboot-schedule - Set Screen Reboot Schedule
PUT /api/screens/{id}/reboot-schedule - Clear Screen Reboot Schedule
DELETE /api/screens/{id}/reboot-schedule - Post Screen Toast
POST /api/screens/{id}/toast - Forecast Screen Storage
POST /api/screens/{id}/storage-forecast - Explain Screen Campaigns
GET /api/screens/{id}/campaigns - Get Screen Screenshot
GET /api/screens/{id}/screenshot - Request Screen Screenshot
POST /api/screens/{id}/screenshot - Get Screen Screenshot Status
GET /api/screens/{id}/screenshot/status - Get Screen Live
GET /api/screens/{id}/live - Start Screen Live
POST /api/screens/{id}/live - Stop Screen Live
DELETE /api/screens/{id}/live - Create Screen Live Viewer
POST /api/screens/{id}/live/viewers - Answer Screen Live Viewer
PUT /api/screens/{id}/live/viewers/{viewer_id} - Start Screen Live Frames
POST /api/screens/{id}/live/frames - Get Screen Live Frame
GET /api/screens/{id}/live/frame - Connect Live Frames
GET /live/frames - Get Screen Health History
GET /api/screens/{id}/health/history - Get Screen Uptime
GET /api/screens/{id}/uptime - Get Screen Presence
GET /api/screens/{id}/presence - Get Health Trend
GET /api/health/trend - Get Project Uptime
GET /api/uptime/daily - List Fleet Links
GET /api/fleet-links - Create Fleet Link
POST /api/fleet-links - Get Fleet Link
GET /api/fleet-links/{id} - Update Fleet Link
PATCH /api/fleet-links/{id} - Delete Fleet Link
DELETE /api/fleet-links/{id} - Rotate Fleet Link
POST /api/fleet-links/{id}/rotate
Campaigns
10 operations with their parameters, request templates and responses.
- List Campaigns
GET /api/campaigns - Create Campaign
POST /api/campaigns - Preview Campaign
POST /api/campaigns/preview - Get Campaign
GET /api/campaigns/{id} - Update Campaign
PATCH /api/campaigns/{id} - Delete Campaign
DELETE /api/campaigns/{id} - List Campaign Revisions
GET /api/campaigns/{id}/revisions - Restore Campaign Revision
POST /api/campaigns/{id}/revisions/{revision}/restore - Promote Campaign
POST /api/campaigns/{id}/promote - List Campaign Screens
GET /api/campaigns/{id}/screens
Schedule import: sheets of schedule rows
3 operations with their parameters, request templates and responses.
- Get Schedule Import Template
GET /api/schedule/imports/template - Preview Schedule Import
POST /api/schedule/imports/preview - Commit Schedule Import
POST /api/schedule/imports
Reviews of agent changes
7 operations with their parameters, request templates and responses.
- List Reviews
GET /api/reviews - Get Review
GET /api/reviews/{id} - Locate Review
GET /api/reviews/{id}/locate - Approve Review
POST /api/reviews/{id}/approve - Reject Review
POST /api/reviews/{id}/reject - Request Review Changes
POST /api/reviews/{id}/request-changes - Withdraw Review
POST /api/reviews/{id}/withdraw
Private advertising networks and campaigns
46 operations with their parameters, request templates and responses.
- Get Advertising Network
GET /api/advertising/network - Create Advertising Network
POST /api/advertising/network - Set Advertising Default Rate
POST /api/advertising/network/rate - List Advertising Inventory
GET /api/advertising/inventory - Put Advertising Inventory
PUT /api/advertising/inventory/{screen_id} - List Advertising Slots
GET /api/advertising/slots - Create Advertising Slot
POST /api/advertising/slots - Update Advertising Slot
POST /api/advertising/slots/{id} - List Advertising Memberships
GET /api/advertising/memberships - Update Advertising Membership
POST /api/advertising/memberships/{id} - Revoke Advertising Membership
POST /api/advertising/memberships/{id}/revoke - List Advertising Joined Networks
GET /api/advertising/networks - List Advertising Joined Inventory
GET /api/advertising/networks/{seller_project_id}/inventory - List Advertising Creatives
GET /api/advertising/creatives - Create Advertising Creative
POST /api/advertising/creatives - Get Advertising Creative
GET /api/advertising/creatives/{id} - List Advertising Seller Campaigns
GET /api/advertising/seller-campaigns - Get Advertising Seller Campaign
GET /api/advertising/seller-campaigns/{id} - List Advertising Campaigns
GET /api/advertising/campaigns - Create Advertising Campaign
POST /api/advertising/campaigns - Get Advertising Campaign
GET /api/advertising/campaigns/{id} - Update Advertising Campaign
POST /api/advertising/campaigns/{id} - Quote Advertising Campaign
POST /api/advertising/campaigns/{id}/quote - Activate Advertising Campaign
POST /api/advertising/campaigns/{id}/activate - Pause Advertising Campaign
POST /api/advertising/campaigns/{id}/pause - Resume Advertising Campaign
POST /api/advertising/campaigns/{id}/resume - Accept Advertising Rates
POST /api/advertising/campaigns/{id}/accept-rates - List Advertising Reviews
GET /api/advertising/reviews - Approve Advertising Review
POST /api/advertising/reviews/{id}/approve - Reject Advertising Review
POST /api/advertising/reviews/{id}/reject - Get Advertising Spend
GET /api/advertising/reports/spend - Get Advertising Delivery
GET /api/advertising/reports/delivery - List Advertising Direct Campaigns
GET /api/advertising/direct-campaigns - Create Advertising Direct Campaign
POST /api/advertising/direct-campaigns - Get Advertising Direct Campaign
GET /api/advertising/direct-campaigns/{id} - Update Advertising Direct Campaign
POST /api/advertising/direct-campaigns/{id} - Pause Advertising Direct Campaign
POST /api/advertising/direct-campaigns/{id}/pause - Resume Advertising Direct Campaign
POST /api/advertising/direct-campaigns/{id}/resume - End Advertising Direct Campaign
POST /api/advertising/direct-campaigns/{id}/end - Get Advertising Direct Campaign Report
GET /api/advertising/direct-campaigns/{id}/report - Estimate Advertising Availability
POST /api/advertising/availability - Get Advertising Fill Stats
GET /api/advertising/reports/fill - Get Advertising Review
GET /api/advertising/reviews/{id} - Get Advertising Review Content
GET /api/advertising/reviews/{id}/content - Head Advertising Review Content
HEAD /api/advertising/reviews/{id}/content - Request Advertising Review Changes
POST /api/advertising/reviews/{id}/request-changes
Comments
9 operations with their parameters, request templates and responses.
- Get Screen Comments
GET /api/comment/screen/{id} - Put Screen Comments
PUT /api/comment/screen/{id} - Delete Screen Comments
DELETE /api/comment/screen/{id} - Get Playlist Comments
GET /api/comment/playlist/{id} - Put Playlist Comments
PUT /api/comment/playlist/{id} - Delete Playlist Comments
DELETE /api/comment/playlist/{id} - Get Playlist Page Comments
GET /api/comment/playlist/{id}/page/{page_id} - Put Playlist Page Comments
PUT /api/comment/playlist/{id}/page/{page_id} - Delete Playlist Page Comments
DELETE /api/comment/playlist/{id}/page/{page_id}
Project notes agents share
5 operations with their parameters, request templates and responses.
- List Notes
GET /api/notes - Add Note
POST /api/notes - Get Note
GET /api/notes/{id} - Confirm Note
POST /api/notes/{id}/confirm - Resolve Note
POST /api/notes/{id}/resolve
Application key/value storage
9 operations with their parameters, request templates and responses.
- List KV
GET /api/applications/{application_id}/kv - Get KV
GET /api/applications/{application_id}/kv/{key} - Put KV
PUT /api/applications/{application_id}/kv/{key} - Delete KV
DELETE /api/applications/{application_id}/kv/{key} - List KVWebhooks
GET /api/applications/{application_id}/kv-webhooks - Create KVWebhook
POST /api/applications/{application_id}/kv-webhooks - Delete KVWebhook
DELETE /api/applications/{application_id}/kv-webhooks/{webhook_id} - Rotate KVWebhook Secret
POST /api/applications/{application_id}/kv-webhooks/{webhook_id}/rotate-secret - Receive KVWebhook
POST /api/applications/{application_id}/kv-webhooks/{webhook_id}/write
Card data for built-in cards
22 operations with their parameters, request templates and responses.
- List Card Types
GET /api/card-types - Get Card Type
GET /api/card-types/{id} - List Cards
GET /api/cards - Create Card
POST /api/cards - Get Card
GET /api/cards/{id} - Patch Card
PATCH /api/cards/{id} - Delete Card
DELETE /api/cards/{id} - Get Instance Data
GET /api/cards/{id}/data - Put Instance Data
PUT /api/cards/{id}/data - List Card KVWebhooks
GET /api/cards/{id}/kv-webhooks - Create Card KVWebhook
POST /api/cards/{id}/kv-webhooks - Update Card KVWebhook
PATCH /api/cards/{id}/kv-webhooks/{webhook_id} - Delete Card KVWebhook
DELETE /api/cards/{id}/kv-webhooks/{webhook_id} - Rotate Card KVWebhook Secret
POST /api/cards/{id}/kv-webhooks/{webhook_id}/rotate-secret - List Card KVWebhook Deliveries
GET /api/cards/{id}/kv-webhooks/{webhook_id}/deliveries - Receive Card KVWebhook
POST /api/cards/{id}/kv-webhooks/{webhook_id}/write - Head Card KVWebhook
HEAD /api/cards/{id}/kv-webhooks/{webhook_id}/write - List Card Data
GET /api/card-data - Get Card Data
GET /api/card-data/{key} - Put Card Data
PUT /api/card-data/{key} - Delete Card Data
DELETE /api/card-data/{key} - Get Feed
GET /api/feeds/{family}
Data sources: addresses that keep a card live
10 operations with their parameters, request templates and responses.
- List Source Presets
GET /api/source-presets - Get Source Preset
GET /api/source-presets/{name} - List Sources
GET /api/sources - Create Source
POST /api/sources - Test Source
POST /api/sources/test - Get Source
GET /api/sources/{source_id} - Update Source
PATCH /api/sources/{source_id} - Delete Source
DELETE /api/sources/{source_id} - Get Source Rooms
GET /api/sources/{source_id}/rooms - Refresh Source
POST /api/sources/{source_id}/refresh
BI dashboards: Power BI, Tableau and signed-in web page connections and views
14 operations with their parameters, request templates and responses.
- List BIConnections
GET /api/bi-connections - Create BIConnection
POST /api/bi-connections - Get BIConnection
GET /api/bi-connections/{id} - Update BIConnection
PATCH /api/bi-connections/{id} - Delete BIConnection
DELETE /api/bi-connections/{id} - Test BIConnection
POST /api/bi-connections/{id}/test - Browse BIConnection
GET /api/bi-connections/{id}/browse - List BIViews
GET /api/bi-views - Create BIView
POST /api/bi-views - Get BIView
GET /api/bi-views/{id} - Update BIView
PATCH /api/bi-views/{id} - Delete BIView
DELETE /api/bi-views/{id} - Test BIView
POST /api/bi-views/{id}/test - Get BIView Image
GET /api/bi-views/{id}/image
Connections: a project's reusable access to Microsoft and Google
9 operations with their parameters, request templates and responses.
- List Connections
GET /api/connections - Create Connection
POST /api/connections - Get Connection
GET /api/connections/{id} - Update Connection
PATCH /api/connections/{id} - Delete Connection
DELETE /api/connections/{id} - Test Connection
POST /api/connections/{id}/test - Connect Connection
POST /api/connections/{id}/connect - Complete Microsoft Connection Consent
GET /oauth/connections/microsoft/callback - Complete Google Connection Consent
GET /oauth/connections/google/callback
Durable project events
2 operations with their parameters, request templates and responses.
- List Events
GET /api/events - Stream Events
GET /stream/project
Notifications: email and signed webhook notices on screen state changes
13 operations with their parameters, request templates and responses.
- List Notifications
GET /api/notifications - Create Notification
POST /api/notifications - Get Notification
GET /api/notifications/{id} - Update Notification
PATCH /api/notifications/{id} - Delete Notification
DELETE /api/notifications/{id} - Rotate Notification Secret
POST /api/notifications/{id}/rotate-secret - Test Notification
POST /api/notifications/{id}/test - List Notification Deliveries
GET /api/notifications/{id}/deliveries - List Notification Delivery Attempts
GET /api/notifications/{id}/deliveries/{delivery_id}/attempts - Resubscribe Notification User
DELETE /api/notifications/{id}/unsubscribed/{user_id} - Show Notification Unsubscribe
GET /api/notifications/unsubscribe - Unsubscribe From Notification
POST /api/notifications/unsubscribe - Resubscribe To Notification
POST /api/notifications/resubscribe
Alerts: open screen problems, acknowledge, snooze and mutes
6 operations with their parameters, request templates and responses.
- List Alerts
GET /api/alerts - Get Alert
GET /api/alerts/{id} - Acknowledge Alert
POST /api/alerts/{id}/acknowledge - List Alert Mutes
GET /api/alert-mutes - Create Alert Mute
POST /api/alert-mutes - Delete Alert Mute
DELETE /api/alert-mutes/{id}
Reports: folder and tag rollups, CSV, XLSX and PDF files and scheduled email
8 operations with their parameters, request templates and responses.
- List Report Kinds
GET /api/reports - Get Report
GET /api/reports/{kind} - List Report Subscriptions
GET /api/report-subscriptions - Create Report Subscription
POST /api/report-subscriptions - Get Report Subscription
GET /api/report-subscriptions/{id} - Update Report Subscription
PATCH /api/report-subscriptions/{id} - Delete Report Subscription
DELETE /api/report-subscriptions/{id} - Send Report Subscription
POST /api/report-subscriptions/{id}/send
Audit log: every configuration change with its before and after, a hash chain to verify, and CSV, XLSX and PDF export
4 operations with their parameters, request templates and responses.
- List Audit Log
GET /api/audit - Get Audit Head
GET /api/audit/head - Verify Audit Log
GET /api/audit/verify - Get Audit Entry
GET /api/audit/{id}
Webhooks: signed event delivery
9 operations with their parameters, request templates and responses.
- List Webhooks
GET /api/webhooks - Create Webhook
POST /api/webhooks - Get Webhook
GET /api/webhooks/{id} - Update Webhook
PATCH /api/webhooks/{id} - Delete Webhook
DELETE /api/webhooks/{id} - Rotate Webhook Secret
POST /api/webhooks/{id}/rotate-secret - Test Webhook
POST /api/webhooks/{id}/test - List Webhook Deliveries
GET /api/webhooks/{id}/deliveries - List Webhook Delivery Attempts
GET /api/webhooks/{id}/deliveries/{delivery_id}/attempts
CAP alert triggers
12 operations with their parameters, request templates and responses.
- List Triggers
GET /api/triggers - Create Trigger
POST /api/triggers - Get Trigger
GET /api/triggers/{id} - Update Trigger
PATCH /api/triggers/{id} - Delete Trigger
DELETE /api/triggers/{id} - Rotate Trigger Secret
POST /api/triggers/{id}/rotate-secret - Test Trigger
POST /api/triggers/{id}/test - Clear Trigger
POST /api/triggers/{id}/clear - Receive Trigger CAP
POST /api/triggers/{id}/cap - Receive Trigger Overlay
POST /api/triggers/{id}/overlay - Head Trigger Overlay
HEAD /api/triggers/{id}/overlay - List Trigger Deliveries
GET /api/triggers/{id}/deliveries
Playback aggregates
4 operations with their parameters, request templates and responses.
- List Playback Aggregates
GET /api/playback - List Playback Plays
GET /api/playback/plays - Get Playback Totals
GET /api/playback/totals - Get Playback Completeness
GET /api/playback/completeness
Feedback: bugs and feature requests
6 operations with their parameters, request templates and responses.
- List Bug Reports
GET /api/feedback/bugs - Report Bug
POST /api/feedback/bugs - List Feature Requests
GET /api/feedback/features - Request Feature
POST /api/feedback/features - Get Feedback Thread
GET /api/feedback/{id} - Reply Feedback Thread
POST /api/feedback/{id}/responses
Support
9 operations with their parameters, request templates and responses.
- Send a website contact message
POST /website/support-messages - Support Status
GET /api/support/status - List Support Conversations
GET /api/support/conversations - Create Support Conversation
POST /api/support/conversations - List Support Messages
GET /api/support/conversations/{id}/messages - Reply Support Conversation
POST /api/support/conversations/{id}/messages - Read Support Conversation
PUT /api/support/conversations/{id}/read - Close Support Conversation
POST /api/support/conversations/{id}/close - Stream Support Messages
GET /stream/support
Website demo requests and bookings
7 operations with their parameters, request templates and responses.
- Submit Website Demo Request
POST /website/demo-requests - Get Website Demo Request
GET /website/demo-request - Get Website Demo Calendar
GET /website/demo-calendar - Get Website Demo Slots
GET /website/demo-slots - Book Website Demo
POST /website/demo-bookings - Request Website Demo Review
POST /website/demo-review - Exchange Website Demo Invitation
POST /website/demo-session
Homepage browser handoff
6 operations with their parameters, request templates and responses.
- Claim Browser Link
POST /api/project/browser-links/claim - Get Browser Link Status
GET /screen/browser-links - Start Browser Link
POST /screen/browser-links - Stream Browser Link Events
GET /stream/browser-links/events - Continue Browser Link
GET /screen/browser-links/continue - Get Browser Link Setup Page
GET /setup
Website setup codes
1 operation with its parameters, request template and responses.
- Get the visitor's setup code
POST /website/setup-codes
Player pairing and sessions
11 operations with their parameters, request templates and responses.
- Start Pairing Session
POST /screen/pairing-sessions - Stream Pairing Events
GET /stream/pairing-events - Complete Pairing Session
POST /screen/pairing-sessions/complete - Create Device Runtime Session
POST /screen/device-sessions - Start Native Pairing Session
POST /screen/native/pairing-sessions - Stream Native Pairing Events
GET /stream/native/pairing-events - Complete Native Pairing Session
POST /screen/native/pairing-sessions/complete - Create Native Identity Challenge
POST /screen/native/identity/challenges - Create Native Identity Runtime Session
POST /screen/native/identity/sessions - Create Screen Link Runtime Session
POST /screen/link-sessions - Reset Native Identity
POST /screen/native/identity/reset
Runtime manifest, reports, and events
25 operations with their parameters, request templates and responses.
- Exchange Browser Provisioning
POST /screen/browser-provisioning/exchanges - Get Runtime Chrome
GET /screen/chrome - Get Runtime Manifest
GET /screen/manifest - Stream Runtime Events
GET /stream/events - Create Runtime Report
POST /screen/reports - Put Runtime Screenshot
PUT /screen/screenshot - Resolve Adslots
POST /screen/adslots/resolve - Report Adslot Events
POST /screen/adslots/events - Put Runtime Observation
PUT /screen/observation - Put Runtime Health
PUT /screen/health - Put Runtime Storage
PUT /screen/storage - Put Runtime Status
PUT /screen/status - Put Runtime Screen Label
PUT /screen/screen-label - Put Runtime Screen Wall
PUT /screen/wall - Post Runtime Command Result
POST /screen/commands/{command_id}/result - Join Runtime Live
POST /screen/live/{live_id}/join - Offer Runtime Live
POST /screen/live/{live_id}/offer - Heartbeat Runtime Live
POST /screen/live/{live_id}/heartbeat - Stopped Runtime Live
POST /screen/live/{live_id}/stopped - Get Runtime Screen Playlists
GET /screen/playlists - Put Runtime Screen Playlist
PUT /screen/playlist - Unpair Runtime
POST /screen/unpair - Launch Application Release
POST /screen/manifests/{manifest_revision}/releases/{release_id}/launch - Resolve all dynamic media selectors for one playlist loop
POST /screen/manifests/{manifest_revision}/selectors/resolve - Get Runtime Card Data
GET /screen/card-data/{key}
Runtime application K/V
4 operations with their parameters, request templates and responses.
- List Runtime KV
GET /screen/apps/{application_id}/kv - Get Runtime KV
GET /screen/apps/{application_id}/kv/{key} - Put Runtime KV
PUT /screen/apps/{application_id}/kv/{key} - Delete Runtime KV
DELETE /screen/apps/{application_id}/kv/{key}
Protected content and release assets
8 operations with their parameters, request templates and responses.
- Get Ad Decision Content
GET /screen/ad-decisions/{decision_id} - Head Ad Decision Content
HEAD /screen/ad-decisions/{decision_id} - Get Stable Protected Media
GET /media/{media_id} - Head Stable Protected Media
HEAD /media/{media_id} - Get Protected Media
GET /media/manifests/{manifest_revision}/{media_id} - Get Native Webapp Package
GET /screen/manifests/{manifest_revision}/releases/{release_id}/package - Head Native Webapp Package
HEAD /screen/manifests/{manifest_revision}/releases/{release_id}/package - Consume Launch Ticket Or Get Release Asset
GET /{asset_path}
People and project dashboard
94 operations with their parameters, request templates and responses.
- Inspect Dashboard Invitation
POST /api/invitations/inspect - Start Dashboard Invitation Passkey
POST /api/invitations/passkey-options - Verify Dashboard Invitation Email
POST /api/invitations/email-verifications - Get Dashboard Invitation Signup
GET /api/invitations/signup - Accept Dashboard Invitation
POST /api/invitations/accept - Start Dashboard Signup Passkey
POST /api/signups/passkey-options - Create Dashboard Signup
POST /api/signups - Switch Dashboard Project
PUT /api/session/project - List Dashboard Members
GET /api/members - Remove Dashboard Member
DELETE /api/members/{user_id} - List Member Activity
GET /api/members/{user_id}/activity - Get Dashboard Me
GET /api/me - Delete Dashboard Me
DELETE /api/me - Start Dashboard Reauthentication
POST /api/me/reauthentications - Set Dashboard Password
PUT /api/me/password - List Dashboard Passkeys
GET /api/me/passkeys - Start Dashboard Passkey Registration
POST /api/me/passkeys/options - Complete Dashboard Passkey Registration
POST /api/me/passkeys/complete - Rename Dashboard Passkey
PATCH /api/me/passkeys/{id} - Delete Dashboard Passkey
DELETE /api/me/passkeys/{id} - Get Dashboard Email
GET /api/me/email - Change Dashboard Email
POST /api/me/email/change - Request Dashboard Email Verification
POST /api/me/email/verification - Put Dashboard Signup Profile
PUT /api/me/signup-profile - Get Dashboard Application Usage
GET /api/applications/{id}/usage - Put Dashboard Advertising Inventory
POST /api/advertising/inventory/{screen_id} - Get Dashboard Media Usage
GET /api/media/{id}/usage - Get Dashboard Media Thumbnail
GET /api/media/{id}/thumbnail - Head Dashboard Media Thumbnail
HEAD /api/media/{id}/thumbnail - Peek Dashboard Email Verification
GET /api/email/verify - Verify Dashboard Email
POST /api/email/verify - Start Dashboard Passkey Assertion
POST /api/webauthn/assertions - Complete Dashboard Passkey Assertion
POST /api/webauthn/assertions/complete - Create Dashboard Session
POST /api/sessions - Get Dashboard Session
GET /api/session - Logout Dashboard Session
POST /api/logout - Record Onboarding Step
POST /api/onboarding/steps - List Dashboard Agents
GET /api/agents - List Dashboard Agent Events
GET /api/agents/{id}/events - Disconnect Dashboard Agent
POST /api/agents/{id}/disconnect - List Dashboard Agent Notes
GET /api/agents/{id}/notes - Resolve Dashboard Agent Note
POST /api/agents/{id}/notes/{note_id}/resolve - Delete Dashboard Agent Note
DELETE /api/agents/{id}/notes/{note_id} - List Dashboard Agent Connections
GET /api/agent-connections/pending - Lookup Dashboard Agent Connection
POST /api/agent-connections/lookup - Get Dashboard Agent Connection
GET /api/agent-connections/{id} - Approve Dashboard Agent Connection
POST /api/agent-connections/{id}/approve - Deny Dashboard Agent Connection
POST /api/agent-connections/{id}/deny - Get Dashboard Boot
GET /api/dashboard/boot - Get Dashboard Summary
GET /api/summary - Get Dashboard Payout Status
GET /api/billing/payout-status - Get Dashboard Receipt
GET /api/billing/receipts/{id} - Get Dashboard Balance
GET /api/balance - Create Dashboard Application Preview Launch
POST /api/applications/{id}/preview-launches - Get Dashboard Organization
GET /api/organizations/{org_id} - Dashboard Organizations Projects
GET /api/organizations/{org_id}/projects - List Dashboard Resellers
GET /api/resellers - Enroll Reseller
POST /api/resellers - Get Dashboard Reseller
GET /api/resellers/{reseller_id} - List Dashboard Reseller Customers
GET /api/resellers/{reseller_id}/customers - Create Dashboard Reseller Customer
POST /api/resellers/{reseller_id}/customers - Get Dashboard Reseller Customer
GET /api/resellers/{reseller_id}/customers/{org_id} - Set Dashboard Reseller Customer Plan
PUT /api/resellers/{reseller_id}/customers/{org_id}/plan - List Dashboard Reseller Customer Projects
GET /api/resellers/{reseller_id}/customers/{org_id}/projects - Join Dashboard Reseller Customer Project
POST /api/resellers/{reseller_id}/customers/{org_id}/projects/{project_id}/access - Get Dashboard Reseller Statement
GET /api/resellers/{reseller_id}/statement - End Dashboard Organization Reseller
DELETE /api/organizations/{org_id}/reseller - Dashboard Organizations Discovery
GET /api/organizations/{org_id}/discovery - Dashboard Organizations Start Domain
POST /api/organizations/{org_id}/domain-challenges - Dashboard Organizations Verify Domain
POST /api/organizations/{org_id}/domain-verification - Dashboard Organizations Admins
GET /api/organizations/{org_id}/admins - Dashboard Organizations Set Admins
PUT /api/organizations/{org_id}/admins - Dashboard Organizations People
GET /api/organizations/{org_id}/people - Dashboard Organizations List Admin Invitations
GET /api/organizations/{org_id}/admin-invitations - Dashboard Organizations Create Admin Invitations
POST /api/organizations/{org_id}/admin-invitations - Dashboard Organizations Revoke Admin Invitation
POST /api/organizations/{org_id}/admin-invitations/{invitation_id}/revoke - Dashboard Organizations List Member Invitations
GET /api/organizations/{org_id}/member-invitations - Dashboard Organizations Create Member Invitations
POST /api/organizations/{org_id}/member-invitations - Dashboard Organizations Revoke Member Invitation
POST /api/organizations/{org_id}/member-invitations/{invitation_id}/revoke - Dashboard Organizations Remove Member
DELETE /api/organizations/{org_id}/members/{user_id} - Dashboard Organizations Set Guest Policy
PUT /api/organizations/{org_id}/guest-policy - Dashboard Organizations Set Library
PUT /api/organizations/{org_id}/library - Dashboard Organizations Set Project Access
POST /api/organizations/{org_id}/project-access - Dashboard Organizations Join Project
POST /api/organizations/{org_id}/projects/{project_id}/access - Dashboard Organizations Set Project Owner
PUT /api/organizations/{org_id}/projects/{project_id}/owner - Dashboard Organizations Remove Project Member
DELETE /api/organizations/{org_id}/projects/{project_id}/members/{user_id} - Dashboard Organizations Remove One Domain
DELETE /api/organizations/{org_id}/domains/{domain} - Set Dashboard Member Approver
PUT /api/members/{user_id}/approver - Set Dashboard Member Screen Scope
PUT /api/members/{user_id}/screen-scope - Clear Dashboard Member Screen Scope
DELETE /api/members/{user_id}/screen-scope - Set Dashboard Agent Screen Scope
PUT /api/agents/{id}/screen-scope - Clear Dashboard Agent Screen Scope
DELETE /api/agents/{id}/screen-scope - Set Dashboard Member Upload Scope
PUT /api/members/{user_id}/upload-scope - Clear Dashboard Member Upload Scope
DELETE /api/members/{user_id}/upload-scope
API lifecycle, deprecations, and rate limits
URL families are /api, /screen, /stream, /media, /website, /agentid. Compatible changes within a major:
- Additive endpoints and methods.
- Optional request members.
- New problem codes.
- New fields only where the published schema permits unknown fields.
- Removing an operation that only answers an error, or that no client calls.
- Removing a response field no client acts on.
These changes require a new major:
- Removal or rename of a working route or field that clients call.
- Type, meaning, or authorization changes.
- Making optional input required.
- Adding a member to a closed enum.
- Adding a field to a closed response object.
A new major overlaps for at least 180 days. Sunset notice is at least 90 days, and a deprecated operation remains served for at least 90 days from the RFC 9745 Deprecation effective date unless a later published commitment controls.
No operations are currently deprecated.
Lifecycle signals are:
- OpenAPI deprecated true on the operation.
- RFC 9745 Deprecation with its effective date.
- RFC 8594 Sunset once the sunset date is fixed.
- Link with rel=deprecation to migration documentation.
Rate-limit fields
Operations with disclosed fixed-window controls declare x-rate-limit-policies. Eligible admitted responses may include the optional RateLimit-Policy and RateLimit structured field list members. Exact replays and deployments without shared admission may omit them. Fixed-window denials include them; concurrency and byte-budget denials may omit them. These fields follow draft-ietf-httpapi-ratelimit-headers-11, an Internet-Draft rather than an RFC. On every 429, Retry-After is authoritative.
RFC 9457 problems
Errors use application/problem+json. Branch on status and stable code; treat detail as explanation. Generated from problems.yaml.
project_required400 · Select a project
type: https://screenrig.ai/problems/project-requiredfree_organization_limit409 · Free organization limit reached
type: https://screenrig.ai/problems/free-organization-limitorganization_plan_required409 · The organization needs a plan before it admits screens
type: https://screenrig.ai/problems/organization-plan-requiredproject_name_conflict409 · Project name already used in the organization
type: https://screenrig.ai/problems/project-name-conflictproject_delete_blocked409 · Project cannot be deleted in its current state
type: https://screenrig.ai/problems/project-delete-blockedowner_required409 · A responsible person is required
type: https://screenrig.ai/problems/owner-requiredowner_cannot_leave409 · The project owner cannot leave
type: https://screenrig.ai/problems/owner-cannot-leaveinternal_error500 · Internal server error
type: https://screenrig.ai/problems/internal-errorinvalid_request400 · Request is invalid
type: https://screenrig.ai/problems/invalid-requestunauthorized401 · Authentication is required
type: https://screenrig.ai/problems/unauthorizedcredential_retired401 · Credential was retired
type: https://screenrig.ai/problems/credential-retiredclient_update_required410 · Update the screenRIG plugin or CLI
type: https://screenrig.ai/problems/client-update-requiredforbidden403 · Request is not allowed
type: https://screenrig.ai/problems/forbiddeninsufficient_access403 · This access level cannot do this
type: https://screenrig.ai/problems/insufficient-accessoutside_upload_scope403 · Outside this uploader's playlists and folders
type: https://screenrig.ai/problems/outside-upload-scopeoutside_screen_scope403 · Outside this member's screens
type: https://screenrig.ai/problems/outside-screen-scopeprotected_target409 · A protected screen is not changed this way
type: https://screenrig.ai/problems/protected-targetsecond_approver_required403 · A second approver must decide this review
type: https://screenrig.ai/problems/second-approver-requiredreserved_item403 · This campaign is reserved
type: https://screenrig.ai/problems/reserved-itemapprover_required403 · Only an approver can do this
type: https://screenrig.ai/problems/approver-requiredreview_not_pending409 · The review is no longer pending
type: https://screenrig.ai/problems/review-not-pendingreview_stale409 · The subject changed after this proposal
type: https://screenrig.ai/problems/review-stalereview_blocked409 · Another review must be decided first
type: https://screenrig.ai/problems/review-blockedplaylist_not_approved409 · The playlist has no approved version
type: https://screenrig.ai/problems/playlist-not-approvedmedia_pending_review409 · The media item is waiting for a person's review
type: https://screenrig.ai/problems/media-pending-reviewmedia_sync_source_refused409 · The media sync source refused the request
type: https://screenrig.ai/problems/media-sync-source-refusedmedia_sync_source_unavailable500 · The media sync source could not be reached
type: https://screenrig.ai/problems/media-sync-source-unavailablecanva_not_configured409 · Canva is not configured
type: https://screenrig.ai/problems/canva-not-configuredcanva_reconnect_required409 · The Canva account needs to be connected
type: https://screenrig.ai/problems/canva-reconnect-requireddropbox_not_configured409 · Dropbox is not configured
type: https://screenrig.ai/problems/dropbox-not-configureddropbox_reconnect_required409 · The Dropbox account needs to be connected
type: https://screenrig.ai/problems/dropbox-reconnect-requiredgoogle_drive_not_configured409 · Google Drive is not configured
type: https://screenrig.ai/problems/google-drive-not-configuredmedia_sync_sharer_not_member403 · The folder was not shared by a project member
type: https://screenrig.ai/problems/media-sync-sharer-not-membernot_found404 · Resource was not found
type: https://screenrig.ai/problems/not-foundmethod_not_allowed405 · Method is not allowed
type: https://screenrig.ai/problems/method-not-allowedidempotency_mismatch409 · Idempotency key does not match the original request
type: https://screenrig.ai/problems/idempotency-mismatchcredential_issuance_expired410 · Credential issuance expired
type: https://screenrig.ai/problems/credential-issuance-expireduser_email_conflict409 · Email address belongs to another person
type: https://screenrig.ai/problems/user-email-conflictprovisioning_invalid404 · Browser provisioning invalid
type: https://screenrig.ai/problems/provisioning-invalidprovisioning_expired410 · Browser provisioning expired
type: https://screenrig.ai/problems/provisioning-expiredprovisioning_consumed409 · Browser provisioning consumed
type: https://screenrig.ai/problems/provisioning-consumedprovisioning_exchange_mismatch409 · Browser provisioning exchange mismatch
type: https://screenrig.ai/problems/provisioning-exchange-mismatchbrowser_already_paired409 · Browser already paired
type: https://screenrig.ai/problems/browser-already-pairedhandoff_code_invalid404 · Browser handoff code invalid
type: https://screenrig.ai/problems/handoff-code-invalidhandoff_code_expired410 · Browser handoff code expired
type: https://screenrig.ai/problems/handoff-code-expiredhandoff_session_rate_limited429 · Browser handoff session rate limited
type: https://screenrig.ai/problems/handoff-session-rate-limitedhandoff_session_conflict409 · Browser handoff session conflict
type: https://screenrig.ai/problems/handoff-session-conflictbrowser_link_not_claimed409 · Browser link not claimed
type: https://screenrig.ai/problems/browser-link-not-claimedbrowser_link_project_mismatch403 · Browser link project mismatch
type: https://screenrig.ai/problems/browser-link-project-mismatchorigin_not_allowed403 · Origin is not allowed
type: https://screenrig.ai/problems/origin-not-allowedresource_conflict409 · Resource state conflicts with the request
type: https://screenrig.ai/problems/resource-conflictcard_not_found404 · Card not found
type: https://screenrig.ai/problems/card-not-foundcard_invalid400 · Card placement is invalid
type: https://screenrig.ai/problems/card-invalidcard_layout_invalid400 · Card layout is invalid
type: https://screenrig.ai/problems/card-layout-invalidcard_layout_conflict400 · Cards on the page claim the same place
type: https://screenrig.ai/problems/card-layout-conflictcard_data_invalid409 · Card data document does not fit a card that reads it
type: https://screenrig.ai/problems/card-data-invalidsource_limit_reached409 · Organization has the maximum data sources
type: https://screenrig.ai/problems/source-limit-reachedsource_target_unsupported422 · The data source cannot fill this card
type: https://screenrig.ai/problems/source-target-unsupportedsource_target_taken409 · Another data source already writes this card
type: https://screenrig.ai/problems/source-target-takensource_busy409 · A sync of the data source is running
type: https://screenrig.ai/problems/source-busysource_has_no_rooms409 · This kind of data source offers no rooms
type: https://screenrig.ai/problems/source-has-no-roomssource_secret_required400 · A data source secret is missing or no longer fits
type: https://screenrig.ai/problems/source-secret-requiredsource_test_failed422 · The data source preview failed
type: https://screenrig.ai/problems/source-test-failedconnection_app_not_configured409 · screenRIG's app is not configured for this provider
type: https://screenrig.ai/problems/connection-app-not-configuredconnection_limit_reached409 · Organization has the maximum connections
type: https://screenrig.ai/problems/connection-limit-reachedcard_media_invalid400 · Card media reference does not name a ready image
type: https://screenrig.ai/problems/card-media-invalidrevision_conflict412 · Resource revision does not match
type: https://screenrig.ai/problems/revision-conflictinvalid_range416 · Requested byte range is not satisfiable
type: https://screenrig.ai/problems/invalid-rangequota_exceeded413 · Project content quota is exceeded
type: https://screenrig.ai/problems/quota-exceededpayment_required402 · Payment is required
type: https://screenrig.ai/problems/payment-requiredreseller_generation_limit402 · Reseller image generation limit reached
type: https://screenrig.ai/problems/reseller-generation-limitfeature_not_in_plan402 · This feature is not in the project's plan
type: https://screenrig.ai/problems/feature-not-in-planrate_limited429 · Request rate is too high
type: https://screenrig.ai/problems/rate-limitedrevocation_unavailable500 · Credential revocation state is unavailable
type: https://screenrig.ai/problems/revocation-unavailabledependency_unavailable500 · Required dependency is unavailable
type: https://screenrig.ai/problems/dependency-unavailabledependency_timeout500 · Required dependency did not answer in time
type: https://screenrig.ai/problems/dependency-timeoutschema_incompatible500 · Database schema is incompatible
type: https://screenrig.ai/problems/schema-incompatiblenot_ready500 · Service is not ready
type: https://screenrig.ai/problems/not-readyserver_draining421 · Service is draining
type: https://screenrig.ai/problems/server-drainingmanifest_degraded500 · Runtime manifest projection is degraded
type: https://screenrig.ai/problems/manifest-degradedscreenshot_unavailable409 · Screenshot is not available
type: https://screenrig.ai/problems/screenshot-unavailableidentity_invalid400 · Player public key is invalid
type: https://screenrig.ai/problems/identity-invalididentity_conflict409 · Player public key does not match the enrollment
type: https://screenrig.ai/problems/identity-conflictenrollment_bound409 · Player public key is already bound to a project
type: https://screenrig.ai/problems/enrollment-boundproof_invalid401 · Player identity proof is invalid
type: https://screenrig.ai/problems/proof-invalidscreen_archived409 · Screen is archived
type: https://screenrig.ai/problems/screen-archivedscreen_archive_required409 · Archive the screen instead of deleting or unbinding it
type: https://screenrig.ai/problems/screen-archive-requiredpasskey_invalid401 · Passkey ceremony is invalid
type: https://screenrig.ai/problems/passkey-invalidpasskey_unknown401 · This passkey is no longer registered
type: https://screenrig.ai/problems/passkey-unknownpasskeys_disabled403 · Passkeys are disabled on this server
type: https://screenrig.ai/problems/passkeys-disabledapplication_in_use409 · A live manifest still references an application release
type: https://screenrig.ai/problems/application-in-useagent_connection_invalid404 · Agent connection is invalid
type: https://screenrig.ai/problems/agent-connection-invalidagent_connection_code_mismatch400 · The code does not match this sign-in
type: https://screenrig.ai/problems/agent-connection-code-mismatchagent_connection_expired410 · Agent connection is expired
type: https://screenrig.ai/problems/agent-connection-expiredagent_connection_conflict409 · Agent connection is already resolved
type: https://screenrig.ai/problems/agent-connection-conflictagent_connection_not_approved409 · Agent connection is not approved
type: https://screenrig.ai/problems/agent-connection-not-approvedagent_limit_exceeded409 · Agent limit is exceeded
type: https://screenrig.ai/problems/agent-limit-exceededagent_lockout_risk409 · Disconnecting the last active agent risks lockout
type: https://screenrig.ai/problems/agent-lockout-riskrecovery_ambiguous409 · Device identifier is attached to more than one screen
type: https://screenrig.ai/problems/recovery-ambiguousrecovery_expired410 · Screen recovery offer has expired
type: https://screenrig.ai/problems/recovery-expiredrecovery_not_offered404 · No screen recovery is pending
type: https://screenrig.ai/problems/recovery-not-offeredinvitation_limit_reached409 · Organization has the maximum outstanding invitations
type: https://screenrig.ai/problems/invitation-limit-reachedorganization_admin_limit409 · Organization admin limit reached
type: https://screenrig.ai/problems/organization-admin-limitlibrary_no_screens409 · A project with screens can't be the Library
type: https://screenrig.ai/problems/library-no-screensguest_not_allowed403 · The organization does not admit this person as a guest
type: https://screenrig.ai/problems/guest-not-allowedmanaged_member409 · An identity provider manages this person
type: https://screenrig.ai/problems/managed-memberorganization_admin_member409 · This member is an organization admin
type: https://screenrig.ai/problems/organization-admin-membermember_owns_projects409 · This member owns projects in the organization
type: https://screenrig.ai/problems/member-owns-projectsmanaged_elsewhere409 · Another organization manages this person
type: https://screenrig.ai/problems/managed-elsewhereversion_required409 · Playlist requires a newer API version
type: https://screenrig.ai/problems/version-requiredprice_change_pending409 · Campaign is paused until new rates are accepted
type: https://screenrig.ai/problems/price-change-pendingquote_stale409 · Advertising quote is stale or expired
type: https://screenrig.ai/problems/quote-staleinsufficient_credits402 · Eligible credits are insufficient
type: https://screenrig.ai/problems/insufficient-creditsself_deal409 · A project cannot buy advertising in its own network
type: https://screenrig.ai/problems/self-dealgoal_overbooked409 · The goal is larger than the available plays
type: https://screenrig.ai/problems/goal-overbookedinvitation_invalid404 · Invitation is invalid
type: https://screenrig.ai/problems/invitation-invalidinvitation_expired410 · Invitation is expired
type: https://screenrig.ai/problems/invitation-expiredinvitation_consumed409 · Invitation is already accepted
type: https://screenrig.ai/problems/invitation-consumedinvitation_email_mismatch403 · Invitation belongs to a different email address
type: https://screenrig.ai/problems/invitation-email-mismatchreauthentication_required401 · Fresh sign-in proof is required
type: https://screenrig.ai/problems/reauthentication-requiredmember_limit_reached409 · Project has the maximum members
type: https://screenrig.ai/problems/member-limit-reachedproject_limit_reached409 · Organization has the maximum projects
type: https://screenrig.ai/problems/project-limit-reachedbilled_by_reseller409 · The organization is billed through its reseller
type: https://screenrig.ai/problems/billed-by-resellerreseller_conflict409 · The organization cannot take that reseller role
type: https://screenrig.ai/problems/reseller-conflictlast_credential409 · Last sign-in method cannot be removed
type: https://screenrig.ai/problems/last-credentialsso_required403 · This address signs in through its identity provider
type: https://screenrig.ai/problems/sso-requiredno_project409 · No current project is selected
type: https://screenrig.ai/problems/no-projectfeature_unavailable404 · This feature is not available on this server
type: https://screenrig.ai/problems/feature-unavailableuser_binding_stale409 · Claiming user email binding is stale
type: https://screenrig.ai/problems/user-binding-stalesession_expired401 · Runtime session is expired or no longer current
type: https://screenrig.ai/problems/session-expiredcredential_revoked401 · Device credential no longer binds this device to a screen
type: https://screenrig.ai/problems/credential-revokedscreen_link_invalid401 · Screen link is not valid
type: https://screenrig.ai/problems/screen-link-invalidscreen_link_not_found404 · Screen has no link
type: https://screenrig.ai/problems/screen-link-not-foundproof_clock_skew401 · Player identity proof is outside the accepted time window
type: https://screenrig.ai/problems/proof-clock-skewkey_retired401 · Player key was replaced and its grace window has closed
type: https://screenrig.ai/problems/key-retiredassignment_not_found404 · Screen has no playlist assignment
type: https://screenrig.ai/problems/assignment-not-foundupgrade_required403 · Player version is below the supported minimum
type: https://screenrig.ai/problems/upgrade-requiredreboot_unsupported409 · Screen cannot reboot remotely
type: https://screenrig.ai/problems/reboot-unsupportedcommand_unsupported409 · Screen cannot do this remotely
type: https://screenrig.ai/problems/command-unsupportedplay_page_unsupported409 · Screen cannot play a page on request
type: https://screenrig.ai/problems/play-page-unsupportedidentify_unsupported409 · Screen cannot identify itself
type: https://screenrig.ai/problems/identify-unsupportedvolume_unsupported409 · Screen cannot set its volume
type: https://screenrig.ai/problems/volume-unsupporteddisplay_output_unsupported409 · Screen cannot set its output mode
type: https://screenrig.ai/problems/display-output-unsupporteddisplay_cec_unsupported409 · Screen cannot take its display's input over CEC
type: https://screenrig.ai/problems/display-cec-unsupportedpage_not_on_screen409 · Page is not in the playlist the screen is playing
type: https://screenrig.ai/problems/page-not-on-screenlive_unsupported409 · Screen cannot show live view
type: https://screenrig.ai/problems/live-unsupportedlive_unavailable409 · Live view is not available for this screen
type: https://screenrig.ai/problems/live-unavailablelive_not_ready409 · The screen is not publishing yet
type: https://screenrig.ai/problems/live-not-readylive_session_ended410 · The live session has ended
type: https://screenrig.ai/problems/live-session-endedwall_unsupported409 · Screen cannot lay out a video wall
type: https://screenrig.ai/problems/wall-unsupportedplaylist_format_mismatch409 · Playlist format does not match the screen's video wall
type: https://screenrig.ai/problems/playlist-format-mismatchprimitive_locked403 · A locked element can be changed only by an approver
type: https://screenrig.ai/problems/primitive-lockedplaylist_is_template409 · The playlist is a template
type: https://screenrig.ai/problems/playlist-is-templatewebhook_limit_reached409 · Organization has the maximum webhooks
type: https://screenrig.ai/problems/webhook-limit-reachedalert_not_open409 · Alert is not open
type: https://screenrig.ai/problems/alert-not-openalert_mute_limit_reached409 · Organization has the maximum mutes
type: https://screenrig.ai/problems/alert-mute-limit-reachednotification_limit_reached409 · Organization has the maximum notifications
type: https://screenrig.ai/problems/notification-limit-reachednotification_covers_other_projects409 · Notification covers other projects
type: https://screenrig.ai/problems/notification-covers-other-projectsreport_subscription_limit_reached409 · Organization has the maximum report subscriptions
type: https://screenrig.ai/problems/report-subscription-limit-reachedfleet_link_limit_reached409 · Organization has the maximum fleet links
type: https://screenrig.ai/problems/fleet-link-limit-reachedwebhook_url_rejected400 · Webhook URL must be HTTPS on a public Internet host
type: https://screenrig.ai/problems/webhook-url-rejectednotification_destination_rejected400 · Notification destination is not valid for its channel
type: https://screenrig.ai/problems/notification-destination-rejecteddocument_not_shared400 · Document asks viewers to sign in
type: https://screenrig.ai/problems/document-not-sharednote_contains_credential422 · Note text contains a credential
type: https://screenrig.ai/problems/note-contains-credentialnote_rejected422 · Note text was rejected
type: https://screenrig.ai/problems/note-rejectednote_not_open409 · Note is not open
type: https://screenrig.ai/problems/note-not-opennote_limit_reached409 · Organization has the maximum open notes
type: https://screenrig.ai/problems/note-limit-reachedtrigger_limit_reached409 · Organization has the maximum triggers
type: https://screenrig.ai/problems/trigger-limit-reachedbi_upstream_refused409 · The BI system refused the connection
type: https://screenrig.ai/problems/bi-upstream-refusedbi_upstream_unavailable500 · The BI system could not be reached
type: https://screenrig.ai/problems/bi-upstream-unavailablebi_web_unavailable409 · This server has no page renderer
type: https://screenrig.ai/problems/bi-web-unavailableschedule_import_invalid422 · The import has rows with errors
type: https://screenrig.ai/problems/schedule-import-invalidschedule_import_stale409 · The project changed since the preview
type: https://screenrig.ai/problems/schedule-import-stalecampaign_limit_reached409 · Organization has the maximum campaigns
type: https://screenrig.ai/problems/campaign-limit-reachedkv_webhook_limit_reached409 · Application has the maximum key/value webhooks
type: https://screenrig.ai/problems/kv-webhook-limit-reachedsupport_conversation_closed409 · Support conversation is closed
type: https://screenrig.ai/problems/support-conversation-closedsubmission_too_short422 · Submission is too short to act on
type: https://screenrig.ai/problems/submission-too-shortsubmission_unclear422 · Submission does not describe a problem or request
type: https://screenrig.ai/problems/submission-unclearsubmission_rejected422 · Submission was not accepted
type: https://screenrig.ai/problems/submission-rejectedsubmission_screening_unavailable500 · Submission cannot be screened right now
type: https://screenrig.ai/problems/submission-screening-unavailabledemo_slot_unavailable409 · Demo time is no longer available
type: https://screenrig.ai/problems/demo-slot-unavailableagentid_claim_invalid400 · AgentID claim is invalid or expired
type: https://screenrig.ai/problems/agentid-claim-invalidagentid_already_enrolled409 · AgentID is already enrolled
type: https://screenrig.ai/problems/agentid-already-enrolledaccount_exists409 · This email already has a screenRIG account
type: https://screenrig.ai/problems/account-existsemail_verification_required403 · Verify your email to continue
type: https://screenrig.ai/problems/email-verification-requiredunverified_account_replacement409 · This reset creates a new, empty account
type: https://screenrig.ai/problems/unverified-account-replacementapp_store_transaction_invalid422 · App Store purchase could not be verified
type: https://screenrig.ai/problems/app-store-transaction-invalidapp_store_account_mismatch409 · Purchase belongs to another organization
type: https://screenrig.ai/problems/app-store-account-mismatcheducation_not_eligible403 · Organization is not eligible for the Education plan
type: https://screenrig.ai/problems/education-not-eligibleapp_store_plan_conflict409 · Organization already holds a plan
type: https://screenrig.ai/problems/app-store-plan-conflictDiagnostics and contract source
Bundled CLI diagnostics keep authorization, cookies, signed upload details, object identifiers, and customer content out of retained output. The raw OpenAPI document is the HTTP source of truth.
Schema index
Generated names, required fields, and schema descriptions; use raw OpenAPI for complete JSON Schema.