Public Developer Docs
Yaelix API for agents, automations, and OpenClaw
The Yaelix API connects your screens with agents, automations, and external systems so content, playlists, and display actions can be controlled directly from workflows such as OpenClaw or messaging-driven inputs.
Built for agents, not only humans
This page explains the business workflow, while the OpenAPI spec remains available as the machine-readable source of truth.
Organizations and API keys
Every request runs in the scope of the API key's organization and uses `Authorization: Bearer yx_live_...` for auth.
Clear content workflow
Agents can create content, assemble playlists, assign screens, and trigger display reloads when needed.
What agents can do with Yaelix today
Manage content
Create and update content entries for images, videos, websites, HTML, or canvas payloads.
Build playlists
Manage playlists with ordering, durations, and optional nested playlist items.
Link screens and displays
Create screens, assign playlists, and connect them to the target display.
Trigger playback changes
Send commands such as `reload`, `skip`, `pause`, `resume`, or `screenshot` directly to displays.
Recommended agent workflow
1
Create an API key
Create an API key in dashboard settings for the target organization.
2
Prepare content
The agent uploads media via the v1 uploads initiate/complete flow (presigned PUT) or creates content from a URL/HTML/canvas. Then it places content into playlists with duration and scheduling.
3
Update a playlist
Add the new content to a playlist or replace an existing sequence.
4
Assign the screen
If needed, assign the playlist to a screen and link the screen to the correct display.
5
Refresh the display
Optionally send a `reload` display command so the change becomes visible immediately.
OpenClaw and WhatsApp: recommended integration
We would not duplicate the docs for OpenClaw. Instead, `/docs` should be the public canonical source, and the agent can work like this:
Text-driven: a customer sends a WhatsApp message describing which screen should change and which existing asset or playlist should be shown.
Media-driven: OpenClaw stores an image or video in its own storage or via the existing Yaelix upload flow, then passes the resulting URL into the public API.
Control-driven: for immediate actions such as reload, skip, or screenshot, OpenClaw can call the display command endpoints directly.
Quickstart for agents
If you are wiring up an agent, treat the OpenAPI spec as the primary source and use these examples as the workflow starter.
export YAELIX_API_BASE="https://api.yaelix.com/api/v1"
export YAELIX_API_KEY="yx_live_..."curl -X POST "$YAELIX_API_BASE/content" \
-H "Authorization: Bearer $YAELIX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Lunch Menu 2026-03-17",
"type": "IMAGE",
"url": "https://assets.example.com/menu.jpg",
"tags": ["openclaw", "whatsapp"]
}'curl -X POST "$YAELIX_API_BASE/displays/<display-id>/command" \
-H "Authorization: Bearer $YAELIX_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "command": "reload" }'Important notes about the current state
The public v1 API currently covers orchestration of content, playlists, screens, and displays.
Direct file upload is part of the public v1 API via uploads initiate/complete (presigned PUT).
The API is organization-scoped. An API key only sees resources within its own organization.
For safe automations, use least-privilege scopes and `Idempotency-Key` for safe retries on mutations.
For agents, `openapi.json` is the best machine-readable source and `/docs` the best public human-readable entry point.
References
OpenAPI JSON
Machine-readable specification for agents, SDK generation, and validation.
Interactive API reference
Useful for manually testing requests and quickly checking endpoint details.
Dashboard API keys
Create and revoke the keys used by production integrations.