Get started with Motherboard X

Motherboard X exposes an HTTP API for display text and routine input, plus an iOS URL scheme for sending text. Choose the interface that fits where your integration runs.

Choose an interface

	Web API	iOS URL scheme
Entry point	POST /api/display over HTTPS	motherboardX://send
Target	A specific board identified by its API ID	The board connected to the Motherboard X app, or a known auto-connect target
Authentication	Board API ID; no end-user login required	The Motherboard X app must be signed in
Operations	Display text in Home or supply a complete value to a routine step that accepts text	Send plain text
Display control	Landscape or portrait; full display, top half, or bottom half in Home	Landscape or portrait for text; no zone parameter
Result	HTTP response; recheck using the same idempotency key	Optional success and error callback URLs
Reference	Web API	iOS URL scheme

Send your first HTTP request

1. Get a X-Motherboard-Api-Id in the Motherboard X App.
2. Create a UUID for this logical display request. Keep it with the exact request body so you can check the result later.
3. Send the curl or JavaScript example with your board’s API ID.
4. Inspect the response. If it is 202 accepted, use the recheck procedure with bounded backoff.

Handling is not the same as visible output

A board may acknowledge delivery even if its current routine step rejects the input. See what delivered means.

Send text from an iOS integration

1. Make sure Motherboard X is installed and signed in.
2. Connect a board, or make sure the app has a known board it can try to reconnect to.
3. Open a URL such as motherboardX://send?type=text&data=Hello%20World.
4. Include x-success and x-error callback URLs if your app needs the result. Encode the callbacks before adding them to the request.

Use send?type=text to send plain text. Sending drawings and reading raw drawing paths are not supported.