Wire examples

Representative shapes for implementers. Full frozen vectors live intest-vectors-v1 on GitHub.

POST /v1/blobs (mailbox relay)

Request bodyPhase 1

{
  "tag": "<base64url 32-byte mailbox tag>",
  "expires_at": "2026-07-12T10:00:00Z",
  "ciphertext": "<base64url outer blob>"
}

POST /v1/relay (entry relay)

Onion uploadPhase 2

{
  "packet": "<base64url CBOR onion layer>",
  "ticket": "<optional relay ticket>"
}

Invite URL

Deep linkPhase 4

yakr://invite/qWhwcm90b2NvbC...<base64url signed CBOR>

CLI quick start

Pair and sendreference CLI

# Operator starts relay
yakr relay serve --port 8090

# Alice invites Bob
yakr invite create --port 8090
yakr invite accept "yakr://invite/..." --name alice

# Send a message (after pairing + profiles)
yakr message send bob "Hello via Yakr"