Documentation

API reference

Find an endpoint, check what it needs, and understand the result. These are the HTTP operations used by the screenRIG plugin, Players, and dashboard.

Publishing to a screen? Start with the plugin setup and CLI guide. Use this reference when you need the underlying requests.

HTTP reference. Generated from the backend contract. Browse endpoints below or download OpenAPI.

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 doingServiceAuthentication
Managing screens and contentapi.screenrig.aiAgent bearer token
Running a Playerplay.screenrig.aiBrowser cookies or native Player credentials
Managing a login and projectsscreenrig.ai/dashboardDashboard cookies
Provisioning people from an identity providerapi.screenrig.ai/scim/v2Organization SCIM token
Loading an application releaseIts exact host under apps.screenrig.aiLaunch 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, and project. A credential calls only routes in its areas; reports also reads any area. A request naming a missing area returns 403 forbidden with 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-signup cookie 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/v2 routes. 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 returns 409 idempotency_mismatch.
  • Revisions: when an endpoint requires If-Match, send the current resource revision; stale writes return 412 revision_conflict.
  • Cursors: list and SSE cursors are opaque.
  • Operations: uploads may begin in receiving, then use queued, running, succeeded, failed, or cancelled.
  • SSE: resume with the last cursor or Last-Event-ID. A stream.resync_required frame 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.

Projects, invitations, and sign-in

149 operations with their parameters, request templates and responses.

Plans, credit balances and statements

6 operations with their parameters, request templates and responses.

Agent installations and connections

3 operations with their parameters, request templates and responses.

OAuth sign-in, tokens and revocation

10 operations with their parameters, request templates and responses.

Single sign-on: sign-in routes, identity provider and policy

13 operations with their parameters, request templates and responses.

User provisioning: SCIM 2.0, tokens and group bindings

24 operations with their parameters, request templates and responses.

Service clients

9 operations with their parameters, request templates and responses.

Applications and operations

11 operations with their parameters, request templates and responses.

Media uploads

43 operations with their parameters, request templates and responses.

Playlists

16 operations with their parameters, request templates and responses.

Screens

86 operations with their parameters, request templates and responses.

Campaigns

10 operations with their parameters, request templates and responses.

Schedule import: sheets of schedule rows

3 operations with their parameters, request templates and responses.

Reviews of agent changes

7 operations with their parameters, request templates and responses.

Private advertising networks and campaigns

46 operations with their parameters, request templates and responses.

Comments

9 operations with their parameters, request templates and responses.

Project notes agents share

5 operations with their parameters, request templates and responses.

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.

Data sources: addresses that keep a card live

10 operations with their parameters, request templates and responses.

BI dashboards: Power BI, Tableau and signed-in web page connections and views

14 operations with their parameters, request templates and responses.

Connections: a project's reusable access to Microsoft and Google

9 operations with their parameters, request templates and responses.

Durable project events

2 operations with their parameters, request templates and responses.

Notifications: email and signed webhook notices on screen state changes

13 operations with their parameters, request templates and responses.

Alerts: open screen problems, acknowledge, snooze and mutes

6 operations with their parameters, request templates and responses.

Reports: folder and tag rollups, CSV, XLSX and PDF files and scheduled email

8 operations with their parameters, request templates and responses.

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.

Webhooks: signed event delivery

9 operations with their parameters, request templates and responses.

CAP alert triggers

12 operations with their parameters, request templates and responses.

Playback aggregates

4 operations with their parameters, request templates and responses.

Feedback: bugs and feature requests

6 operations with their parameters, request templates and responses.

Support

9 operations with their parameters, request templates and responses.

Website demo requests and bookings

7 operations with their parameters, request templates and responses.

Homepage browser handoff

6 operations with their parameters, request templates and responses.

Website setup codes

1 operation with its parameters, request template and responses.

Player pairing and sessions

11 operations with their parameters, request templates and responses.

Runtime manifest, reports, and events

25 operations with their parameters, request templates and responses.

Runtime application K/V

4 operations with their parameters, request templates and responses.

Protected content and release assets

8 operations with their parameters, request templates and responses.

People and project dashboard

94 operations with their parameters, request templates and responses.

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_required

400 · Select a project

type: https://screenrig.ai/problems/project-required
free_organization_limit

409 · Free organization limit reached

type: https://screenrig.ai/problems/free-organization-limit
organization_plan_required

409 · The organization needs a plan before it admits screens

type: https://screenrig.ai/problems/organization-plan-required
project_name_conflict

409 · Project name already used in the organization

type: https://screenrig.ai/problems/project-name-conflict
project_delete_blocked

409 · Project cannot be deleted in its current state

type: https://screenrig.ai/problems/project-delete-blocked
owner_required

409 · A responsible person is required

type: https://screenrig.ai/problems/owner-required
owner_cannot_leave

409 · The project owner cannot leave

type: https://screenrig.ai/problems/owner-cannot-leave
internal_error

500 · Internal server error

type: https://screenrig.ai/problems/internal-error
invalid_request

400 · Request is invalid

type: https://screenrig.ai/problems/invalid-request
unauthorized

401 · Authentication is required

type: https://screenrig.ai/problems/unauthorized
credential_retired

401 · Credential was retired

type: https://screenrig.ai/problems/credential-retired
client_update_required

410 · Update the screenRIG plugin or CLI

type: https://screenrig.ai/problems/client-update-required
forbidden

403 · Request is not allowed

type: https://screenrig.ai/problems/forbidden
insufficient_access

403 · This access level cannot do this

type: https://screenrig.ai/problems/insufficient-access
outside_upload_scope

403 · Outside this uploader's playlists and folders

type: https://screenrig.ai/problems/outside-upload-scope
outside_screen_scope

403 · Outside this member's screens

type: https://screenrig.ai/problems/outside-screen-scope
protected_target

409 · A protected screen is not changed this way

type: https://screenrig.ai/problems/protected-target
second_approver_required

403 · A second approver must decide this review

type: https://screenrig.ai/problems/second-approver-required
reserved_item

403 · This campaign is reserved

type: https://screenrig.ai/problems/reserved-item
approver_required

403 · Only an approver can do this

type: https://screenrig.ai/problems/approver-required
review_not_pending

409 · The review is no longer pending

type: https://screenrig.ai/problems/review-not-pending
review_stale

409 · The subject changed after this proposal

type: https://screenrig.ai/problems/review-stale
review_blocked

409 · Another review must be decided first

type: https://screenrig.ai/problems/review-blocked
playlist_not_approved

409 · The playlist has no approved version

type: https://screenrig.ai/problems/playlist-not-approved
media_pending_review

409 · The media item is waiting for a person's review

type: https://screenrig.ai/problems/media-pending-review
media_sync_source_refused

409 · The media sync source refused the request

type: https://screenrig.ai/problems/media-sync-source-refused
media_sync_source_unavailable

500 · The media sync source could not be reached

type: https://screenrig.ai/problems/media-sync-source-unavailable
canva_not_configured

409 · Canva is not configured

type: https://screenrig.ai/problems/canva-not-configured
canva_reconnect_required

409 · The Canva account needs to be connected

type: https://screenrig.ai/problems/canva-reconnect-required
dropbox_not_configured

409 · Dropbox is not configured

type: https://screenrig.ai/problems/dropbox-not-configured
dropbox_reconnect_required

409 · The Dropbox account needs to be connected

type: https://screenrig.ai/problems/dropbox-reconnect-required
google_drive_not_configured

409 · Google Drive is not configured

type: https://screenrig.ai/problems/google-drive-not-configured
media_sync_sharer_not_member

403 · The folder was not shared by a project member

type: https://screenrig.ai/problems/media-sync-sharer-not-member
not_found

404 · Resource was not found

type: https://screenrig.ai/problems/not-found
method_not_allowed

405 · Method is not allowed

type: https://screenrig.ai/problems/method-not-allowed
idempotency_mismatch

409 · Idempotency key does not match the original request

type: https://screenrig.ai/problems/idempotency-mismatch
credential_issuance_expired

410 · Credential issuance expired

type: https://screenrig.ai/problems/credential-issuance-expired
user_email_conflict

409 · Email address belongs to another person

type: https://screenrig.ai/problems/user-email-conflict
provisioning_invalid

404 · Browser provisioning invalid

type: https://screenrig.ai/problems/provisioning-invalid
provisioning_expired

410 · Browser provisioning expired

type: https://screenrig.ai/problems/provisioning-expired
provisioning_consumed

409 · Browser provisioning consumed

type: https://screenrig.ai/problems/provisioning-consumed
provisioning_exchange_mismatch

409 · Browser provisioning exchange mismatch

type: https://screenrig.ai/problems/provisioning-exchange-mismatch
browser_already_paired

409 · Browser already paired

type: https://screenrig.ai/problems/browser-already-paired
handoff_code_invalid

404 · Browser handoff code invalid

type: https://screenrig.ai/problems/handoff-code-invalid
handoff_code_expired

410 · Browser handoff code expired

type: https://screenrig.ai/problems/handoff-code-expired
handoff_session_rate_limited

429 · Browser handoff session rate limited

type: https://screenrig.ai/problems/handoff-session-rate-limited
handoff_session_conflict

409 · Browser handoff session conflict

type: https://screenrig.ai/problems/handoff-session-conflict
browser_link_not_claimed

409 · Browser link not claimed

type: https://screenrig.ai/problems/browser-link-not-claimed
browser_link_project_mismatch

403 · Browser link project mismatch

type: https://screenrig.ai/problems/browser-link-project-mismatch
origin_not_allowed

403 · Origin is not allowed

type: https://screenrig.ai/problems/origin-not-allowed
resource_conflict

409 · Resource state conflicts with the request

type: https://screenrig.ai/problems/resource-conflict
card_not_found

404 · Card not found

type: https://screenrig.ai/problems/card-not-found
card_invalid

400 · Card placement is invalid

type: https://screenrig.ai/problems/card-invalid
card_layout_invalid

400 · Card layout is invalid

type: https://screenrig.ai/problems/card-layout-invalid
card_layout_conflict

400 · Cards on the page claim the same place

type: https://screenrig.ai/problems/card-layout-conflict
card_data_invalid

409 · Card data document does not fit a card that reads it

type: https://screenrig.ai/problems/card-data-invalid
source_limit_reached

409 · Organization has the maximum data sources

type: https://screenrig.ai/problems/source-limit-reached
source_target_unsupported

422 · The data source cannot fill this card

type: https://screenrig.ai/problems/source-target-unsupported
source_target_taken

409 · Another data source already writes this card

type: https://screenrig.ai/problems/source-target-taken
source_busy

409 · A sync of the data source is running

type: https://screenrig.ai/problems/source-busy
source_has_no_rooms

409 · This kind of data source offers no rooms

type: https://screenrig.ai/problems/source-has-no-rooms
source_secret_required

400 · A data source secret is missing or no longer fits

type: https://screenrig.ai/problems/source-secret-required
source_test_failed

422 · The data source preview failed

type: https://screenrig.ai/problems/source-test-failed
connection_app_not_configured

409 · screenRIG's app is not configured for this provider

type: https://screenrig.ai/problems/connection-app-not-configured
connection_limit_reached

409 · Organization has the maximum connections

type: https://screenrig.ai/problems/connection-limit-reached
card_media_invalid

400 · Card media reference does not name a ready image

type: https://screenrig.ai/problems/card-media-invalid
revision_conflict

412 · Resource revision does not match

type: https://screenrig.ai/problems/revision-conflict
invalid_range

416 · Requested byte range is not satisfiable

type: https://screenrig.ai/problems/invalid-range
quota_exceeded

413 · Project content quota is exceeded

type: https://screenrig.ai/problems/quota-exceeded
payment_required

402 · Payment is required

type: https://screenrig.ai/problems/payment-required
reseller_generation_limit

402 · Reseller image generation limit reached

type: https://screenrig.ai/problems/reseller-generation-limit
feature_not_in_plan

402 · This feature is not in the project's plan

type: https://screenrig.ai/problems/feature-not-in-plan
rate_limited

429 · Request rate is too high

type: https://screenrig.ai/problems/rate-limited
revocation_unavailable

500 · Credential revocation state is unavailable

type: https://screenrig.ai/problems/revocation-unavailable
dependency_unavailable

500 · Required dependency is unavailable

type: https://screenrig.ai/problems/dependency-unavailable
dependency_timeout

500 · Required dependency did not answer in time

type: https://screenrig.ai/problems/dependency-timeout
schema_incompatible

500 · Database schema is incompatible

type: https://screenrig.ai/problems/schema-incompatible
not_ready

500 · Service is not ready

type: https://screenrig.ai/problems/not-ready
server_draining

421 · Service is draining

type: https://screenrig.ai/problems/server-draining
manifest_degraded

500 · Runtime manifest projection is degraded

type: https://screenrig.ai/problems/manifest-degraded
screenshot_unavailable

409 · Screenshot is not available

type: https://screenrig.ai/problems/screenshot-unavailable
identity_invalid

400 · Player public key is invalid

type: https://screenrig.ai/problems/identity-invalid
identity_conflict

409 · Player public key does not match the enrollment

type: https://screenrig.ai/problems/identity-conflict
enrollment_bound

409 · Player public key is already bound to a project

type: https://screenrig.ai/problems/enrollment-bound
proof_invalid

401 · Player identity proof is invalid

type: https://screenrig.ai/problems/proof-invalid
screen_archived

409 · Screen is archived

type: https://screenrig.ai/problems/screen-archived
screen_archive_required

409 · Archive the screen instead of deleting or unbinding it

type: https://screenrig.ai/problems/screen-archive-required
passkey_invalid

401 · Passkey ceremony is invalid

type: https://screenrig.ai/problems/passkey-invalid
passkey_unknown

401 · This passkey is no longer registered

type: https://screenrig.ai/problems/passkey-unknown
passkeys_disabled

403 · Passkeys are disabled on this server

type: https://screenrig.ai/problems/passkeys-disabled
application_in_use

409 · A live manifest still references an application release

type: https://screenrig.ai/problems/application-in-use
agent_connection_invalid

404 · Agent connection is invalid

type: https://screenrig.ai/problems/agent-connection-invalid
agent_connection_code_mismatch

400 · The code does not match this sign-in

type: https://screenrig.ai/problems/agent-connection-code-mismatch
agent_connection_expired

410 · Agent connection is expired

type: https://screenrig.ai/problems/agent-connection-expired
agent_connection_conflict

409 · Agent connection is already resolved

type: https://screenrig.ai/problems/agent-connection-conflict
agent_connection_not_approved

409 · Agent connection is not approved

type: https://screenrig.ai/problems/agent-connection-not-approved
agent_limit_exceeded

409 · Agent limit is exceeded

type: https://screenrig.ai/problems/agent-limit-exceeded
agent_lockout_risk

409 · Disconnecting the last active agent risks lockout

type: https://screenrig.ai/problems/agent-lockout-risk
recovery_ambiguous

409 · Device identifier is attached to more than one screen

type: https://screenrig.ai/problems/recovery-ambiguous
recovery_expired

410 · Screen recovery offer has expired

type: https://screenrig.ai/problems/recovery-expired
recovery_not_offered

404 · No screen recovery is pending

type: https://screenrig.ai/problems/recovery-not-offered
invitation_limit_reached

409 · Organization has the maximum outstanding invitations

type: https://screenrig.ai/problems/invitation-limit-reached
organization_admin_limit

409 · Organization admin limit reached

type: https://screenrig.ai/problems/organization-admin-limit
library_no_screens

409 · A project with screens can't be the Library

type: https://screenrig.ai/problems/library-no-screens
guest_not_allowed

403 · The organization does not admit this person as a guest

type: https://screenrig.ai/problems/guest-not-allowed
managed_member

409 · An identity provider manages this person

type: https://screenrig.ai/problems/managed-member
organization_admin_member

409 · This member is an organization admin

type: https://screenrig.ai/problems/organization-admin-member
member_owns_projects

409 · This member owns projects in the organization

type: https://screenrig.ai/problems/member-owns-projects
managed_elsewhere

409 · Another organization manages this person

type: https://screenrig.ai/problems/managed-elsewhere
version_required

409 · Playlist requires a newer API version

type: https://screenrig.ai/problems/version-required
price_change_pending

409 · Campaign is paused until new rates are accepted

type: https://screenrig.ai/problems/price-change-pending
quote_stale

409 · Advertising quote is stale or expired

type: https://screenrig.ai/problems/quote-stale
insufficient_credits

402 · Eligible credits are insufficient

type: https://screenrig.ai/problems/insufficient-credits
self_deal

409 · A project cannot buy advertising in its own network

type: https://screenrig.ai/problems/self-deal
goal_overbooked

409 · The goal is larger than the available plays

type: https://screenrig.ai/problems/goal-overbooked
invitation_invalid

404 · Invitation is invalid

type: https://screenrig.ai/problems/invitation-invalid
invitation_expired

410 · Invitation is expired

type: https://screenrig.ai/problems/invitation-expired
invitation_consumed

409 · Invitation is already accepted

type: https://screenrig.ai/problems/invitation-consumed
invitation_email_mismatch

403 · Invitation belongs to a different email address

type: https://screenrig.ai/problems/invitation-email-mismatch
reauthentication_required

401 · Fresh sign-in proof is required

type: https://screenrig.ai/problems/reauthentication-required
member_limit_reached

409 · Project has the maximum members

type: https://screenrig.ai/problems/member-limit-reached
project_limit_reached

409 · Organization has the maximum projects

type: https://screenrig.ai/problems/project-limit-reached
billed_by_reseller

409 · The organization is billed through its reseller

type: https://screenrig.ai/problems/billed-by-reseller
reseller_conflict

409 · The organization cannot take that reseller role

type: https://screenrig.ai/problems/reseller-conflict
last_credential

409 · Last sign-in method cannot be removed

type: https://screenrig.ai/problems/last-credential
sso_required

403 · This address signs in through its identity provider

type: https://screenrig.ai/problems/sso-required
no_project

409 · No current project is selected

type: https://screenrig.ai/problems/no-project
feature_unavailable

404 · This feature is not available on this server

type: https://screenrig.ai/problems/feature-unavailable
user_binding_stale

409 · Claiming user email binding is stale

type: https://screenrig.ai/problems/user-binding-stale
session_expired

401 · Runtime session is expired or no longer current

type: https://screenrig.ai/problems/session-expired
credential_revoked

401 · Device credential no longer binds this device to a screen

type: https://screenrig.ai/problems/credential-revoked
screen_link_invalid

401 · Screen link is not valid

type: https://screenrig.ai/problems/screen-link-invalid
screen_link_not_found

404 · Screen has no link

type: https://screenrig.ai/problems/screen-link-not-found
proof_clock_skew

401 · Player identity proof is outside the accepted time window

type: https://screenrig.ai/problems/proof-clock-skew
key_retired

401 · Player key was replaced and its grace window has closed

type: https://screenrig.ai/problems/key-retired
assignment_not_found

404 · Screen has no playlist assignment

type: https://screenrig.ai/problems/assignment-not-found
upgrade_required

403 · Player version is below the supported minimum

type: https://screenrig.ai/problems/upgrade-required
reboot_unsupported

409 · Screen cannot reboot remotely

type: https://screenrig.ai/problems/reboot-unsupported
command_unsupported

409 · Screen cannot do this remotely

type: https://screenrig.ai/problems/command-unsupported
play_page_unsupported

409 · Screen cannot play a page on request

type: https://screenrig.ai/problems/play-page-unsupported
identify_unsupported

409 · Screen cannot identify itself

type: https://screenrig.ai/problems/identify-unsupported
volume_unsupported

409 · Screen cannot set its volume

type: https://screenrig.ai/problems/volume-unsupported
display_output_unsupported

409 · Screen cannot set its output mode

type: https://screenrig.ai/problems/display-output-unsupported
display_cec_unsupported

409 · Screen cannot take its display's input over CEC

type: https://screenrig.ai/problems/display-cec-unsupported
page_not_on_screen

409 · Page is not in the playlist the screen is playing

type: https://screenrig.ai/problems/page-not-on-screen
live_unsupported

409 · Screen cannot show live view

type: https://screenrig.ai/problems/live-unsupported
live_unavailable

409 · Live view is not available for this screen

type: https://screenrig.ai/problems/live-unavailable
live_not_ready

409 · The screen is not publishing yet

type: https://screenrig.ai/problems/live-not-ready
live_session_ended

410 · The live session has ended

type: https://screenrig.ai/problems/live-session-ended
wall_unsupported

409 · Screen cannot lay out a video wall

type: https://screenrig.ai/problems/wall-unsupported
playlist_format_mismatch

409 · Playlist format does not match the screen's video wall

type: https://screenrig.ai/problems/playlist-format-mismatch
primitive_locked

403 · A locked element can be changed only by an approver

type: https://screenrig.ai/problems/primitive-locked
playlist_is_template

409 · The playlist is a template

type: https://screenrig.ai/problems/playlist-is-template
webhook_limit_reached

409 · Organization has the maximum webhooks

type: https://screenrig.ai/problems/webhook-limit-reached
alert_not_open

409 · Alert is not open

type: https://screenrig.ai/problems/alert-not-open
alert_mute_limit_reached

409 · Organization has the maximum mutes

type: https://screenrig.ai/problems/alert-mute-limit-reached
notification_limit_reached

409 · Organization has the maximum notifications

type: https://screenrig.ai/problems/notification-limit-reached
notification_covers_other_projects

409 · Notification covers other projects

type: https://screenrig.ai/problems/notification-covers-other-projects
report_subscription_limit_reached

409 · Organization has the maximum report subscriptions

type: https://screenrig.ai/problems/report-subscription-limit-reached
fleet_link_limit_reached

409 · Organization has the maximum fleet links

type: https://screenrig.ai/problems/fleet-link-limit-reached
webhook_url_rejected

400 · Webhook URL must be HTTPS on a public Internet host

type: https://screenrig.ai/problems/webhook-url-rejected
notification_destination_rejected

400 · Notification destination is not valid for its channel

type: https://screenrig.ai/problems/notification-destination-rejected
document_not_shared

400 · Document asks viewers to sign in

type: https://screenrig.ai/problems/document-not-shared
note_contains_credential

422 · Note text contains a credential

type: https://screenrig.ai/problems/note-contains-credential
note_rejected

422 · Note text was rejected

type: https://screenrig.ai/problems/note-rejected
note_not_open

409 · Note is not open

type: https://screenrig.ai/problems/note-not-open
note_limit_reached

409 · Organization has the maximum open notes

type: https://screenrig.ai/problems/note-limit-reached
trigger_limit_reached

409 · Organization has the maximum triggers

type: https://screenrig.ai/problems/trigger-limit-reached
bi_upstream_refused

409 · The BI system refused the connection

type: https://screenrig.ai/problems/bi-upstream-refused
bi_upstream_unavailable

500 · The BI system could not be reached

type: https://screenrig.ai/problems/bi-upstream-unavailable
bi_web_unavailable

409 · This server has no page renderer

type: https://screenrig.ai/problems/bi-web-unavailable
schedule_import_invalid

422 · The import has rows with errors

type: https://screenrig.ai/problems/schedule-import-invalid
schedule_import_stale

409 · The project changed since the preview

type: https://screenrig.ai/problems/schedule-import-stale
campaign_limit_reached

409 · Organization has the maximum campaigns

type: https://screenrig.ai/problems/campaign-limit-reached
kv_webhook_limit_reached

409 · Application has the maximum key/value webhooks

type: https://screenrig.ai/problems/kv-webhook-limit-reached
support_conversation_closed

409 · Support conversation is closed

type: https://screenrig.ai/problems/support-conversation-closed
submission_too_short

422 · Submission is too short to act on

type: https://screenrig.ai/problems/submission-too-short
submission_unclear

422 · Submission does not describe a problem or request

type: https://screenrig.ai/problems/submission-unclear
submission_rejected

422 · Submission was not accepted

type: https://screenrig.ai/problems/submission-rejected
submission_screening_unavailable

500 · Submission cannot be screened right now

type: https://screenrig.ai/problems/submission-screening-unavailable
demo_slot_unavailable

409 · Demo time is no longer available

type: https://screenrig.ai/problems/demo-slot-unavailable
agentid_claim_invalid

400 · AgentID claim is invalid or expired

type: https://screenrig.ai/problems/agentid-claim-invalid
agentid_already_enrolled

409 · AgentID is already enrolled

type: https://screenrig.ai/problems/agentid-already-enrolled
account_exists

409 · This email already has a screenRIG account

type: https://screenrig.ai/problems/account-exists
email_verification_required

403 · Verify your email to continue

type: https://screenrig.ai/problems/email-verification-required
unverified_account_replacement

409 · This reset creates a new, empty account

type: https://screenrig.ai/problems/unverified-account-replacement
app_store_transaction_invalid

422 · App Store purchase could not be verified

type: https://screenrig.ai/problems/app-store-transaction-invalid
app_store_account_mismatch

409 · Purchase belongs to another organization

type: https://screenrig.ai/problems/app-store-account-mismatch
education_not_eligible

403 · Organization is not eligible for the Education plan

type: https://screenrig.ai/problems/education-not-eligible
app_store_plan_conflict

409 · Organization already holds a plan

type: https://screenrig.ai/problems/app-store-plan-conflict

Diagnostics 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.