Skip to navigation

Authentication

View as Markdown

Prerequisites

💡 Konfidant API is a service that is provided to Premium and Enterprise users. The “Free” subscription tier doesn’t include API usage.

🎗️ Only organization admins can create API tokens and access the “API Tokens” page.

Authentication

On Konfidant, visit the /dashboard and access the “API Keys” section from the sidebar.

Using the “Create New API Key” button, create a new API token. The fields you need to fill are as follows:

FieldDefault ValueOptional/MandatoryDescription
NameN/AMandatoryA name to distinguish tokens from each other.
EnvironmentLiveMandatoryAn environment to distinguish tokens from each other.
Expires AtNeverOptionalAn expiry date for the token. Leave empty for keys that never expire.
Rate Limit60MandatoryAllowed requests/minute from this token. Maximum 240.
Scopesfiles:create, texts:createMandatoryScopes to define token capabilities. files:create, texts:create and shares:list

⚠️ The shares:list scope is usually only available to organization admins.

Using the API key

Send the key as a Bearer token on every request to https://www.konfidant.app/api/v1/...:

curl 'https://www.konfidant.app/api/v1/shares' \
--header 'Authorization: Bearer kf_live_...'

Send the API key only to the Konfidant API. Do not send it to the presigned upload_url used for file uploads or to download hosts; the official SDKs handle this for you.

The API key authorizes creating and listing shares. It cannot decrypt anything: content is encrypted on your side and the decryption key exists only in the share link. See Zero-Knowledge Encryption.