Create and revoke keys at my.quavern.com/account/quavsit. Send one as a bearer token:
curl -sS "https://api.quavern.net/v1/networks/tbm" \ -H "Authorization: Bearer qv_p_…"
What a key is
Personal and read-only. It carries the scope
transit:read, which covers every read endpoint of the API, for the audienceapi.quavern.net.Shown once, at creation, and stored as a hash. It cannot be shown again.
Named by you, for your own bookkeeping. Name it after the application or script that will hold it.
Revocable at any time, from the same page.
The optional scope account:read lets the same key read GET /v1/me on api.quavern.ai for the plan and usage summary. It grants nothing extra on the transit API. Scopes are chosen at creation and cannot be widened afterwards — create a new key instead.
How many keys
Plan | Active keys |
Free | 2 |
Pay as you go | 5 |
Starter | 5 |
Pro | 20 |
Max | 50 |
Enterprise | 500 |
Creating one beyond the limit is refused.
What is not accepted
Browser session tokens from myQuavern, Marl chat or any other Quavern application.
A key issued for another service, such as a Marl key for
api.quavern.ai.Organisation service tokens. Quavsit has personal plans only in this version.
A key belonging to an account whose e-mail address is not verified. Verify the address first — this is the most common reason a brand-new key is refused.
GET /v1/health and GET /v1/status need no key and are not metered. Everything else without a valid key is refused.
Keeping a key safe
Send keys only over HTTPS and only from code you control: a backend, a script, a CLI. Never put one in browser code or in a public repository. A key that has been exposed should be revoked and replaced rather than watched.
Each key reports its own daily usage on the account page, so one key per application makes a leak easier to spot and cheaper to fix.
Departure boards and widgets never hold a key. They carry their own token, which grants exactly one thing.
If a key is refused
In this order: the address is verified, the key has not been revoked, it is a Quavsit key and not a Marl one, and you are calling api.quavern.net. If all four hold, write to [email protected] with the route and the support code from the response — never the key itself.
Quavern help reference: quavsit-api-keys/en