Schnellstart

SDK installieren

npm install @uiap/web-sdk

UIAP initialisieren

import { createUIAP } from "@uiap/web-sdk";

const uiap = createUIAP({
  app: {
    id: "my-app",
    version: "1.0.0",
    profile: "[email protected]",
  },
  transport: myTransport,
});

await uiap.start();

UI annotieren

Füge data-uiap-* Attribute zu deinen HTML-Elementen hinzu:

<button
  data-uiap-id="video.submit"
  data-uiap-action="video.create"
  data-uiap-risk="confirm"
>
  Video erstellen
</button>

Oder nutze programmatische Bindings:

uiap.bindElement(document.querySelector("#submit"), {
  id: "video.submit",
  defaultAction: "video.create",
  risk: "confirm",
});

Actions registrieren

uiap.registerAction(
  {
    id: "video.create",
    kind: "domain",
    risk: { level: "confirm", tags: ["external_effect"] },
  },
  async (ctx) => {
    await app.actions.createVideo();
    return { status: "succeeded", sideEffectState: "applied" };
  }
);

Nächste Schritte

• Lies die Core-Spezifikation für das Protokoll-Grundverständnis
• Erkunde die SDK API für die vollständige Client-API
• Erfahre Warum UIAP? für die Motivation hinter dem Protokoll