Documentation · Start here

Quickstart

One path for compliance-first ai agent platforms. Finish line = a green public verify — not Flomisma moving money.

1. 1. Get an API key

   /get-started — Developer tier free, no card.

2. 2. Connect the relay

   Zero server-side session storage by architecture.

   relay-connect.ts

   Copy

   1npm i @flomisma/relay-client
   2
   3import { FlomismaRelay } from '@flomisma/relay-client'
   4
   5const relay = new FlomismaRelay({
   6  url: process.env.NEXT_PUBLIC_RELAY_URL!,
   7  apiKey: process.env.FLOMISMA_API_KEY!,
   8})
   9
   10await relay.connect()
   11await relay.subscribe('agents/demo')
   12relay.publish('agents/demo', { type: 'ping', at: Date.now() })▋

3. 3. Record a proof / obligation

   Use the obligation ledger four-call flow (create → proof → verify → record instruction). Flomisma stores metadata and emits events; your licensee processor executes value movement. Obligation API.

4. 4. Public verify (done)

   Share /verifier with a customer or auditor. No API key.

   verify.sh

   Copy

   1# After you have a contractId or pipelineRootHash from your portal/API:
   2open https://www.flomisma.com/verifier
   3# Paste the id/hash — no API key required▋