Öffentliche Entwickler-Doku
Yaelix API für Agents, Automationen und OpenClaw
Die Yaelix API verbindet deine Screens mit Agents, Automationen und externen Systemen. So lassen sich Inhalte, Playlists und Display-Aktionen direkt aus Workflows wie OpenClaw oder Messaging-Eingängen steuern.
Für Agents statt nur für Menschen
Diese Seite erklärt den fachlichen Workflow. Die OpenAPI-Spezifikation bleibt als maschinenlesbare Quelle verlinkt.
Organisationen und API-Schlüssel
Jeder Request arbeitet im Kontext der Organisation des API-Schlüssels und wird per `Authorization: Bearer yx_live_...` authentifiziert.
Klarer Content-Workflow
Agents können Inhalte anlegen, Playlists zusammenstellen, Screens zuweisen und Displays bei Bedarf direkt neu laden.
Was Agents heute mit Yaelix tun können
Inhalte verwalten
Content-Einträge für Bilder, Videos, Webseiten, HTML oder Canvas anlegen und aktualisieren.
Playlists bauen
Playlists mit Reihenfolge, Dauer und optionalen verschachtelten Inhalten pflegen.
Screens und Displays verbinden
Screens erstellen, einer Playlist zuordnen und anschliessend mit einem Display verknüpfen.
Wiedergabe anstossen
Kommandos wie `reload`, `skip`, `pause`, `resume` oder `screenshot` direkt an Displays senden.
Empfohlener Agenten-Workflow
1
API-Schlüssel erzeugen
Im Dashboard unter Einstellungen einen API-Schlüssel für die gewünschte Organisation anlegen.
2
Inhalt bereitstellen
Der Agent lädt Medien direkt hoch (Uploads initiate/complete) oder erstellt einen Content-Eintrag mit URL, HTML oder Canvas. Danach wird Content mit Scheduling/Dauer in Playlists platziert.
3
Playlist aktualisieren
Der neue Inhalt wird einer Playlist hinzugefügt oder ersetzt eine bestehende Zusammenstellung.
4
Screen zuordnen
Falls nötig, wird die Playlist einem Screen zugewiesen und der Screen mit dem gewünschten Display verknüpft.
5
Display refreshen
Zum Schluss kann der Agent per Display-Command ein `reload` auslösen, damit die Änderung sofort sichtbar wird.
OpenClaw und WhatsApp: empfohlene Integration
Für OpenClaw würden wir die Docs nicht duplizieren, sondern `/docs` als kanonische öffentliche Quelle verwenden. Der Agent kann dann so arbeiten:
Textbasiert: Ein Kunde schreibt per WhatsApp, welcher Screen aktualisiert werden soll und welche Playlist oder welches bestehende Asset angezeigt werden soll.
Medienbasiert: OpenClaw speichert ein Bild oder Video zuerst in einem eigenen Storage oder über den bestehenden Yaelix Upload-Flow und übergibt danach die URL an die öffentliche API.
Steuerbasiert: Für Sofortaktionen wie Neu laden, Überspringen oder Screenshot nutzt OpenClaw direkt die Display-Commands.
Schnellstart für Agents
Wenn du einen Agenten anbindest, nutze die OpenAPI-Spezifikation als Primärquelle und diese Beispiele als fachlichen Startpunkt.
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" }'Wichtige Hinweise zum aktuellen Stand
Die öffentliche v1 API deckt die Orchestrierung von Content, Playlists, Screens und Displays ab.
Direkte Datei-Uploads sind Teil der öffentlichen v1 API (Uploads initiate/complete). Für grosse Dateien nutzt du den presigned PUT Upload-Flow.
Die API ist organisationsbezogen. Ein API-Schlüssel sieht nur die Ressourcen seiner eigenen Organisation.
Für sichere Automationen empfehlen wir Scopes (Least-Privilege) und `Idempotency-Key` für sichere Retries bei Mutationen.
Für Agents ist `openapi.json` die beste maschinenlesbare Quelle, `/docs` die beste menschenlesbare Einstiegseite.
Referenzen
OpenAPI JSON
Maschinenlesbare Spezifikation für Agenten, SDK-Generatoren und Validierung.
Interaktive API-Referenz
Zum manuellen Testen einzelner Requests und zum schnellen Nachschlagen.
Dashboard API-Schlüssel
Hier erzeugst und widerrufst du die Schlüssel für produktive Integrationen.