Documentation
Authentication
Choose an API key with owner defined scopes or an OAuth token limited by the user’s consent.
Choose the right authentication path
If the software acts for you, use an API key. If it acts for another Kaneme user, use OAuth and let that person grant the exact permissions.
API key · your software acting for you
Use this for your scripts, server, CI, or an agent you operate yourself.
- Credential
- Authorization: Bearer kaneme_…
- Permissions
- Choose scopes when creating the key in Connections.
- Revocation
- Revoke one key at a time in Connections. The next call is refused.
- Limit
- A key cannot gain broader rights after creation. Revoke it and create a new one.
OAuth · a client acting for a user
Use this for an MCP client or a third party product acting for a Kaneme user.
- Credential
- Authorization code followed by a short lived access token.
- Permissions
- 6 scopes are presented separately on the consent screen.
- Revocation
- Connected clients and granted rights are visible and revocable in Connections.
- Limit
- Identity never implies permission. Kaneme validates the stored grant on every call.
OAuth scopes
Public certificate publishing and lifecycle management are off by default. The user must select them explicitly.
voice:read· Read your voices and account- Your voices, their texts, beliefs, documents, and balance. Nothing is changed and no credits are used.
voice:measure· Measure a text against your voice- Free review, stamp, and comparison of two writings. The stamp and the comparison use credits.
voice:write· Create and edit your voices and documents- Create a voice, add texts, create or edit documents. Uses credits.
voice:generate· Generate writing in your voice- Write or realign a text on your behalf, in your voice. Uses credits.
voice:certify· Issue a public certificate- Publish a public certificate anyone can verify. Preparing is free; publishing uses credits.
voice:manage· Manage your content lifecycle- Separate permission: archive, trash, restore, or revoke. Free, and nothing is ever permanently deleted.