Getting Started

Build with the Vexo Ring

Vexo turns a smart ring into a programmable, consent-first stream of human context. Go from pairing to your first capture in minutes — then ship it anywhere through the distribution loop.

Start building View API referencenpm i @vexoring/sdk

5 min

Quickstart

Pair a ring and stream your first capture in under five minutes with the step-by-step guide.

OAuth 2.1

Authentication

Mint scoped @vexoring tokens and act on behalf of consenting users over OAuth.

REST · WS

Captures API

Read the capture → distribution loop and subscribe to biometric events in real time.

MCP

MCP Marketplace

Publish a consented context server so agents can use Vexo data, with the user in control.

Core concepts

Three primitives power everything you build on Vexo. Understand them once and the rest of the API falls into place.

Biometric stream

Heart rate, HRV, temperature and motion, sampled on-device and delivered as a typed event feed.

Distribution loop

Every capture fans out through a consent-gated pipeline to the destinations a user has authorized.

Consented marketplace

Context servers run behind explicit, revocable scopes — nothing leaves the ring without a grant.

Your first capture

Authenticate, open a stream, and react to the loop. The SDK handles pairing, retries and consent refresh for you.

capture.ts

import { Vexo } from "@vexoring/sdk"

const vexo = new Vexo({ token: process.env.VEXO_TOKEN })

// stream the capture → distribution loop
for await (const capture of vexo.captures.stream()) {
  console.log(capture.hrv, capture.context)
}