API

API overview and authentication

REST endpoints for Business and Enterprise accounts to translate text and read current word usage with API-key authentication.

The DeepReference API lets a server-side application translate text with the same engine, glossaries, and Translation Memory as the workspace. It currently exposes translation and usage endpoints and is available on Business and Enterprise plans.

API keys

• Account admins create and manage API keys (they start with dr_) in enterprise settings, alongside team members and shared assets.
• A key authenticates as your account and consumes your word allowance. Keep it in an environment variable or a secret manager, never in client-side code or a repository.
• Keys can be renamed (so "CMS production" and "staging" stay distinguishable), disabled and re-enabled, or revoked permanently. Disable first, revoke when you are sure.

Authentication

Send your key with every request, either as a Bearer token or in the X-API-Key header:

curl https://www.deepreference.com/api/v1/usage \
  -H "Authorization: Bearer dr_your_key_here"

curl https://www.deepreference.com/api/v1/usage \
  -H "X-API-Key: dr_your_key_here"

How API usage is billed

Exactly like the app: you are charged for the visible words in the returned translation, never for prompts, instructions, or internal processing. API usage draws from the same monthly allowance as your workspace; check it any time with the usage endpoint.

Workspace assets also apply to API calls

API requests use the language assets and billing allowance attached to the account. A translation sent from a CMS or internal service can therefore use the same glossary rules and exact Translation Memory matches as a request made in the workspace.