Build with the whole network

The building blocks

Every OpenVibe product runs on these, and your app can call the same ones with a project's token.

Just want to use OpenVibe? Chat with Vibe, OpenVibe's assistant, or see everything people do here.

What you can build today

Each card is a working example in OpenVibe.Examples (MIT, with a smoke test) or a service you can call now.

Start from one: npx --package=https://codeload.github.com/OpenVibers/OpenVibe.Examples/tar.gz/refs/tags/v0.3.0 create-openvibe-app my-app --template web (templates: web, server, bot, mod). All examples · Every way to mod the network.

Quick start

openvibe-sdk v0.65.0, for Node and the browser. Public reads need no key; an app's calls use the client id and secret of a sandbox app in your project.

// npm i https://codeload.github.com/OpenVibers/OpenVibe.SDK/tar.gz/refs/tags/v0.65.0
const sdk = require('openvibe-sdk');
const ov = sdk.createClient();                  // public reads need no token

const search = sdk.search.createSearchClient(ov);
const { results } = await search.query('patch notes', { owner: 'blog' });

const registry = sdk.registry.createRegistryClient(ov);
const services = await registry.services();     // every service, with its health

const sdk = require('openvibe-sdk');
const tokens = sdk.auth.createServiceTokenClient({
    clientId: process.env.OV_CLIENT_ID, clientSecret: process.env.OV_CLIENT_SECRET,
});
const ov = sdk.createClient({ tokenProvider: tokens });
const { unverifiedClaims } = await tokens.getTokenInfo({ audience: 'openvibe.media' });
const media = sdk.media.createMediaClient(ov, { app: unverifiedClaims.project_id });
const file = await media.upload(bytes, { filename: 'logo.png', contentType: 'image/png' });

curl -s https://openvibe.network/oauth/token \
  -d grant_type=client_credentials \
  -d client_id="$OV_CLIENT_ID" -d client_secret="$OV_CLIENT_SECRET" \
  -d audience=openvibe.media
# → {"access_token":"…","token_type":"Bearer","expires_in":300,…}

Everything an integration needs

Each piece is a public API with a reference generated from what production runs.

Services you can build on

Each one runs in production today; its API reference is generated from the capabilities it declares, and the counts are the ones an app can be granted.

From account to integration

1. Create a projectSigned in with your OpenVibe account. New projects are sandbox-only; staff enable production.
2. Add a sandbox appA confidential app gets a client secret, shown once.
3. Pick capabilitiesRequest them for the app; they are approved only inside the project's allowance.
4. Get a tokencreateServiceTokenClient() for client credentials, or sign people in with authorization code + PKCE.
5. Receive eventsSubscribe, then verify each delivery's signature.
6. Publish a releaseValidated release metadata; rotate or revoke credentials any time.

What a project gets

Projects cost nothing today: no plan to buy and no card to add. What a project gets is its limits, and these are the numbers OpenVibe.Events enforces for every project.

These are the limits the service enforces, read from openvibe.events/limits.json.

Reference

Generated from openvibe-contracts v0.217.0 and openvibe-sdk v0.65.0: API explorer · contracts · capabilities · events · services · tools · SDK · all limits.

Questions developers ask