Skip to main content

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, reference texts, beliefs, documents, and remaining credits. No changes and no credits used.
voice:measure · Measure a text against your voice
Voice alignment score, author verdicts, and writing comparisons. Uses voice credits, except for the free local style score.
voice:write · Create and edit your voices and documents
Create a voice, add reference texts, create or edit documents, and store sources. Uses voice credits.
voice:generate · Generate writing in your voice
Generate writing using your voice or realign an existing text. This action writes on your behalf and uses voice credits.
voice:certify · Issue a public certificate
Prepare and publish a certificate that anyone can verify. Publishing uses the cost shown by estimate_cost; preparation is free.
voice:manage · Manage your content lifecycle
Archive, trash, restore, expire, or revoke content. No credits used; API keys and agents cannot permanently delete content.