API Overview
Endpoint Reference
Base URL:
https://api.lezu.app
Authenticated API routes use:
Authorization: ApiKey lez_...
Browser clients may use session cookies created by the auth endpoints.
Health
| Method | Endpoint | Purpose |
|---|---|---|
GET |
/health |
Check whether the API is reachable. |
Authentication
| Method | Endpoint | Purpose |
|---|---|---|
POST |
/v1/auth/sign-up |
Create a user and start a browser session. |
POST |
/v1/auth/sign-in |
Authenticate a user and start a browser session. |
POST |
/v1/auth/sign-out |
End the current browser session. |
GET |
/v1/auth/session |
Return the current session user or null. |
GET |
/v1/users/me |
Return the current authenticated user. |
PATCH |
/v1/users/me |
Update the current user’s profile. |
DELETE |
/v1/users/me |
Deactivate the current user account. |
API Keys
| Method | Endpoint | Required scope | Purpose |
|---|---|---|---|
GET |
/v1/api-keys |
admin:api-keys |
List API keys for the current owner. |
POST |
/v1/api-keys |
admin:api-keys |
Create an API key and return the raw token once. |
DELETE |
/v1/api-keys/:apiKeyId |
admin:api-keys |
Revoke an API key. |
Organizations
| Method | Endpoint | Required scope | Purpose |
|---|---|---|---|
GET |
/v1/organizations |
admin:api-keys |
List organizations for the current user. |
POST |
/v1/organizations |
admin:api-keys |
Create an organization. |
GET |
/v1/organizations/:organizationId |
admin:api-keys |
Read an organization. |
PATCH |
/v1/organizations/:organizationId |
admin:api-keys |
Update an organization name or slug. |
GET |
/v1/organizations/:organizationId/members |
admin:api-keys |
List organization members. |
I18n
| Method | Endpoint | Required scope | Purpose |
|---|---|---|---|
GET |
/v1/i18n/projects |
i18n:read |
List projects. |
POST |
/v1/i18n/projects |
i18n:write |
Create a project and source locale. |
GET |
/v1/i18n/projects/:projectId |
i18n:read |
Read a project. |
PATCH |
/v1/i18n/projects/:projectId |
i18n:write |
Update a project name or source locale. |
DELETE |
/v1/i18n/projects/:projectId |
i18n:write |
Archive a project. |
GET |
/v1/i18n/projects/:projectId/children |
i18n:read |
List child projects below a parent project. |
POST |
/v1/i18n/projects/:projectId/children |
i18n:write |
Create a child project that inherits the parent project language/settings setup. |
GET |
/v1/i18n/projects/:projectId/locales |
i18n:read |
List project locales. |
POST |
/v1/i18n/projects/:projectId/locales |
i18n:write |
Create a locale. |
PATCH |
/v1/i18n/projects/:projectId/locales/:localeCode |
i18n:write |
Update a locale name or enabled state. |
DELETE |
/v1/i18n/projects/:projectId/locales/:localeCode |
i18n:write |
Disable a translated non-source locale by default; ?deleteValues=true explicitly purges stored values. |
GET |
/v1/i18n/projects/:projectId/environments |
i18n:read |
List project environments. |
POST |
/v1/i18n/projects/:projectId/environments |
releases:write |
Create a release environment. |
PATCH |
/v1/i18n/projects/:projectId/environments/:environmentId |
releases:write |
Update a release environment. |
DELETE |
/v1/i18n/projects/:projectId/environments/:environmentId |
releases:write |
Archive a release environment. |
GET |
/v1/i18n/projects/:projectId/keys |
i18n:read |
List project translation keys. |
POST |
/v1/i18n/projects/:projectId/keys |
i18n:write |
Create a translation key. |
PATCH |
/v1/i18n/projects/:projectId/keys/:keyId |
i18n:write |
Rename a translation key. |
DELETE |
/v1/i18n/projects/:projectId/keys/:keyId |
i18n:write |
Archive a translation key. |
GET |
/v1/i18n/projects/:projectId/glossary |
i18n:read |
List project glossary terms. |
POST |
/v1/i18n/projects/:projectId/glossary |
i18n:write |
Create a glossary term. |
PATCH |
/v1/i18n/projects/:projectId/glossary/:termId |
i18n:write |
Update a glossary term. |
DELETE |
/v1/i18n/projects/:projectId/glossary/:termId |
i18n:write |
Archive a glossary term. |
GET |
/v1/i18n/projects/:projectId/values |
i18n:read |
List imported translation values. |
PATCH |
/v1/i18n/projects/:projectId/values/:valueId |
i18n:write |
Manually update a translation value and record history. |
POST |
/v1/i18n/projects/:projectId/import |
i18n:write |
Import JSON, CSV, YAML, or XLIFF content and optionally translate missing target values. |
POST |
/v1/i18n/projects/:projectId/export |
i18n:read |
Export locale values as flat JSON, CSV, YAML, or XLIFF. |
POST |
/v1/i18n/projects/:projectId/files/json-import |
i18n:write |
Upload a JSON file as multipart form data. |
GET |
/v1/i18n/projects/:projectId/releases |
releases:read |
List releases for a project. |
POST |
/v1/i18n/projects/:projectId/releases |
releases:write |
Publish immutable release bundles. |
GET |
/v1/i18n/bundles/:projectId/:environment/:localeCode |
Public bundle route | Fetch the latest published bundle for runtime use. |
Use /v1/i18n/* routes for new integrations.
Translate
| Method | Endpoint | Required scope | Purpose |
|---|---|---|---|
POST |
/v1/translate/text |
translate:write |
Translate one string. |
POST |
/v1/translate/bulk |
translate:write |
Translate many strings into one target language. |
POST |
/v1/translate/multilingual |
translate:write |
Translate many strings into many target languages. |
POST |
/v1/translate/estimate |
translate:read |
Estimate translation units before running work. |
POST |
/v1/translate/jobs |
translate:write |
Create an async translation job. |
GET |
/v1/translate/jobs/:jobId |
translate:read |
Read job status and usage. |
GET |
/v1/translate/jobs/:jobId/result |
translate:read |
Read completed structured results. |
POST |
/v1/translate/jobs/:jobId/cancel |
translate:write |
Cancel a queued or running job. |
Usage and Billing
| Method | Endpoint | Required scope | Purpose |
|---|---|---|---|
GET |
/v1/usage |
usage:read |
Return usage totals for the current owner. |
GET |
/v1/billing |
usage:read |
Return plan and credit summary. |
GET |
/v1/billing/plan |
usage:read |
Return current plan shape. |
GET |
/v1/billing/credits |
usage:read |
Return only credit state. |
GET |
/v1/billing/ledger |
usage:read |
Return usage records as credit ledger rows. |
POST |
/v1/billing/checkout-sessions |
usage:read |
Create a PayPal checkout order for credit packs. |
POST |
/v1/billing/checkout-sessions/:orderId/capture |
usage:read |
Capture an approved PayPal order and grant credits. |
Dashboard
| Method | Endpoint | Required scope | Purpose |
|---|---|---|---|
GET |
/v1/dashboard/summary |
usage:read |
Return a workspace summary for dashboards and reporting views. |
GET |
/v1/dashboard/projects |
i18n:read |
Return project summary rows. |
GET |
/v1/dashboard/activity |
i18n:read |
Return recent imports, releases, and translation jobs. |
GET |
/v1/dashboard/usage |
usage:read |
Return usage and credit state for dashboard panels. |