Skip to content
Jami3D
Developer docs menu

Changelog

Every version of the SDK, the protocol and the API, newest first. Changes are additive only.

Current versions

WhatVersion
jami3d and @jami3d/protocol (npm)0.1.0
SDK ↔ player protocol1
/v1 API1
Live AI turns1
Voice1
The card (EmbedMeta)1
Webhook payloads1

jami3d and @jami3d/protocol are released together under one version. The contracts each carry their own version and only ever gain: a new major would be offered beside the old one, never instead of it.

Versions

  1. The first preview on npm

    · jami3d 0.1.0 · protocol 1 · /v1 1 · turns 1 · voice 1 · card 1 · webhooks 1

    • jami3d and @jami3d/protocol 0.1.0 on npm under the MIT licence (npm install jami3d), with the contracts of version 1 unchanged.
    • 0.x versions are previews: the package's own API may still change. From 1.0.0, every change is additive.
  2. Version 1 of the contract

    · jami3d 0.0.0 · protocol 1 · /v1 1 · turns 1 · voice 1 · card 1 · webhooks 1

    • jami3d: createPlayer for a project or a marketplace listing, with the facade, lazy mounting, the page registry and iOS pseudo-fullscreen; jami3d/react, jami3d/vue, <jami3d-player> (jami3d/element) and the CDN build window.Jami3D.
    • jami3d/webhooks: verifyWebhook for your backend.
    • Protocol 1: the Hello / Welcome handshake, 16 events, 21 commands, 12 error codes; PlayerOptions as the single options contract.
    • /v1: viewer sessions, the turn and voice routes, the card (of a project or a listing) and oEmbed, and the server API — viewer-token grants, projects, usage, results and learner reports.
    • Webhooks: release.published, session.completed, result.quiz_answered, result.retracted and webhook.test, signed with Jami-Signature.