Quickstart

Pick one of three paths. The goal for each is a first result within a minute of having a key.

Get a key

B3OS beta is invite-only. Redeem your invite code in the dashboard; it creates your organization, a project and a first API key. The key is shown once, with an export line to copy:

bash
export B3OS_API_KEY="b3os_sk_..."

Keys start with b3os_sk_. The first key gets the default scopes: read, write and run for vision, render, sandboxes, routines, actions and infer, plus vault:read, vault:run and platform:read. Keys, scopes and principals covers the rest.

Check the key works:

bash
curl -s https://beta-api.b3os.org/v1/keys/current \  -H "Authorization: Bearer $B3OS_API_KEY"

The response names your organization, project and scopes.

Pick a path