List the connected team's screens: online status and what each screen and sub-screen shows right now (its normal content, pushed content, a scene or screen mirroring), with the end time if there is one. Also returns the account's time zone and current local time. Filter with query (part of a screen or sub-screen name) or screen_id. Results come in pages: pass next_cursor as cursor for the next page.
Parameterslimitquerycursorscreen_id
search_content
Search content
Search the team's content that can be shown on a screen: files, designs, apps, split screens and playlists. Newest first. Returns the id, name and type of each item.
Parameterstypelimitquery
push_content
Show content on a screen
Show content on one screen, or on one sub-screen of a split screen, in place of what it shows now, until a time or until it is put back to normal. A split screen needs a subscreen_id. Returns what the screen shows afterwards. Content only appears once the screen is online and has a player paired; the result includes online and paired when the connection may read screens.
Parametersuntilscreen_idrequiredcontent_idrequiredsubscreen_id
release_screen
Put a screen back to normal
End pushed content or a scene on one screen or sub-screen; it goes back to its own content.
Parametersscreen_idrequiredsubscreen_id
List the team's scenes in their order, with their state (live, partly live, changed since it went live, off) and which screens and sub-screens each scene sets (at most 20 targets per scene; targets_total is the real number). Results come in pages: pass next_cursor as cursor for the next page.
Parameterslimitcursor
activate_scene
Start a scene
Put a scene live: every screen and sub-screen in the scene switches at once, in place of what it shows. Running it again puts changes to the scene live. A screen only shows the scene once it is online and has a player paired; each result includes online and paired when the connection may read screens.
Parametersscene_idrequired
release_scene
Put a scene back to normal
End one scene: its screens go back to their own content.
Parametersscene_idrequired
release_all
Put everything back to normal
End all scenes and all pushed content on the team's screens. Screen mirroring keeps running.
Takes no parameters.
create_design
Create a design
Create a design (a full-screen slide for a screen, such as a menu, an announcement or an event poster) from a description. It picks a fitting template, fills in the text and adds stock photos where the template has them; no images are generated with AI. The design is saved in the team's files and can be shown on a screen or used in a scene. Each design uses the account's AI budget, with at most 20 designs per hour.
Parametersnamebriefrequiredlanguageorientation
search_help
Search Screenbird help
Search the Screenbird help center (how features work, setup, troubleshooting). Returns up to 3 articles with title, summary and link; set full to true for the complete text of each article.
Parametersfullqueryrequiredlanguage
get_install_steps
Get install steps for a player
Steps to install the Screenbird player on a device type, ending with the pairing code that the user enters in the dashboard.
Parametersdevicerequired
check_device
Check if a device works
Check whether a device (as the user names it, for example "Samsung TV", "Chromecast", "iPad") works with Screenbird. Returns works, coming_soon, does_not_work, works_in_browser or unknown, with an explanation.
Parametersdevicerequired