API
Getting Started
- You can use the API directly via HTTPS requests, or with our Command Line tool and locizer module.
- The API supports both public and private (API-key protected) endpoints.
- Depending on your CDN type, the API domain may differ.
Tip: Store your API keys securely and never expose write keys in client-side code or public repositories.
Main Capabilities
- Fetch translations for any namespace, version, and language
- Fetch available languages for a project
- Report missing or used translations (for development workflows)
- Update or remove translations in bulk
- Add context or tags to translations
Usage Notes
- All endpoints use standard HTTP verbs (GET, POST, etc).
- Most endpoints require your projectId (and sometimes an API key).
- For large updates, batch your requests (max 1000 keys per request).
- For production, use only read endpoints or API keys with limited permissions.
- See the Going to production guide for best practices.
API Endpoint Explorer
Browse all available endpoints grouped by category. Click an endpoint for details and usage examples.
Domain:🌐 Applies to all endpoints
Global API Key:🔒 Used for all endpoints that require authorization
CDN
Endpoints for CDN resource fetching.
- GET/{projectId}/{version}/{language}/{namespace}▶
Fetch namespace resources
- GET/private/{projectId}/{version}/{language}/{namespace}🔒▶
Fetch private namespace resources
- GET/languages/{projectId}▶
Fetch the available languages
Translations
Fetch, update, report missing/used translations, and manage translation content.
- POST/missing/{projectId}/{version}/{language}/{namespace}🔒▶
Missing translations
- POST/update/{projectId}/{version}/{language}/{namespace}🔒▶
Update or remove translations
- POST/used/{projectId}/{version}/{language}/{namespace}🔒▶
Report used translations
Namespaces
Manage translation namespaces: create, rename, delete, and fetch namespace resources.
- POST/create/{projectId}/{version}/{language}/{namespace}🔒▶
Create a new namespace in a specific language
- POST/create/{projectId}/{version}/{namespace}🔒▶
Create a new namespace in the reference language
- DELETE/delete/{projectId}/{version}/{namespace}🔒▶
Delete a namespace from all languages
- GET/download/{projectId}🔒▶
List all namespace resources (all versions)
- GET/download/{projectId}/{version}🔒▶
List all namespace resources for a version
- GET/download/{projectId}/{version}/{language}🔒▶
List all namespace resources for a language
- GET/download/{projectId}/{version}/{language}/{namespace}🔒▶
Get a specific namespace resource
- GET/pull/{projectId}/{version}/{language}/{namespace}🔒▶
Fetch/filter the (unpublished) namespace resources
- POST/rename/{projectId}/{version}/{namespace}/{toNamespace}🔒▶
Rename a namespace in all languages
Languages
Manage project languages: add, remove, update, and list available languages.
- POST/language/{projectId}/{language}🔒▶
Add a new language to a project
- DELETE/language/{projectId}/{language}🔒▶
Remove language
- PUT/language/{projectId}🔒▶
Update languages for a project
- POST/copy/{projectId}/version/{fromVersion}/{version}/{language}🔒▶
Copy a language from one version to another
Versions
Versioning: copy, publish, add, remove, and manage translation versions.
- POST/version/{projectId}/{version}🔒▶
Add a new version to a project
- DELETE/version/{projectId}/{version}🔒▶
Remove a version
- POST/copy/{projectId}/version/{fromVersion}/{version}🔒▶
Copy all translations from one version to another
- POST/publish/{projectId}/{version}🔒▶
Publish a version
Users
User and invitation management for projects.
- GET/users/{projectId}🔒▶
Fetch users
- POST/invite/{projectId}🔒▶
Invite new users
Tenants
Multi-tenant project management.
- GET/tenants/{projectId}🔒▶
List all tenants of project
- POST/tenant/create/{projectId}🔒▶
Create a new tenant project
- PUT/tenant/update/{projectId}/{tenantProjectId}🔒▶
Update tenant project settings
- POST/tenant/subscribe/{projectId}/{tenantProjectId}🔒▶
Subscribe tenant project
Branches
Branching and branch management for projects.
- DELETE/branch/{projectId}🔒▶
Delete a branch project
- GET/branches/{projectId}🔒▶
List all branches of project
- POST/branch/merge/{projectId}🔒▶
Merge a branch
- POST/branch/create/{projectId}/{version}🔒▶
Create a new branched project
Statistics
Project and user statistics endpoints.
- GET/stats/project/{projectId}🔒▶
Statistics: project
- GET/stats/user/{projectId}/{userId}🔒▶
Statistics: user
- GET/stats/users/{projectId}🔒▶
Statistics: user
Projects
Other project related stuff.
- GET/jobs/{projectId}/{jobId}🔒▶
Get async job status