Platform Documentation
This section covers the Comvi platform — the web app where you manage translations and the REST API behind it. The REST API is for authoring, automation, and dev tooling; production apps load translations at runtime from the CDN, or bundle them at build time via the CLI or an export.
How the platform fits in
Section titled “How the platform fits in”flowchart LR
subgraph Manage["Manage"]
Dashboard["Comvi dashboard"]
ICE["In-Context Editor"]
APIin["REST API (push)"]
CLIin["CLI (push)"]
end
Platform["Comvi Platform"]
subgraph Deliver["Deliver"]
CDN["CDN<br/>(runtime fetch)"]
CLIout["CLI pull<br/>(build-time bundle)"]
end
Apps["Your apps"]
Your["Your systems<br/>(CI, Slack, ...)"]
Dashboard --> Platform
ICE --> Platform
APIin --> Platform
CLIin --> Platform
Platform -- publish --> CDN
Platform --> CLIout
Platform -- events --> Your
CDN --> Apps
CLIout --> Apps
Start here
Section titled “Start here”Two common starting paths, depending on what you want to do first:
Set up the platformCreate a project, add languages and keys, translate, and publish — without writing any app code.
Connect an appLoad translations into any app — web, mobile, backend. Runtime CDN fetch or build-time bundling.
Browse by topic
Section titled “Browse by topic”Getting Started
Section titled “Getting Started”Core ConceptsProjects, languages, keys, namespaces, and how they relate.
Your First ProjectEnd-to-end walkthrough from empty account to a live CDN URL.
Consume TranslationsLoad published bundles into any app or runtime.
Managing Content
Section titled “Managing Content”Everything you do on the Translations page, plus the structures around it.
ProjectsCreate and configure projects.
LanguagesSource and target languages, locale codes.
TranslationsThe editor, statuses, history, comments.
Translation LifecycleHow values move from untranslated to translated, and how publish fits in.
NamespacesGroup keys for code-splitting and organization.
Import & ExportBulk file I/O and migration from other TMS.
CDN DeploymentPublish and serve translations from the edge.
Productivity
Section titled “Productivity”Tools that speed up translation work without sacrificing quality.
Machine TranslationDeepL, Google, OpenAI, Anthropic, and when to use which.
Translation MemoryReuse previous translations across projects.
GlossariesEnforce consistent terminology.
Team & Access
Section titled “Team & Access”Team ManagementInvite and manage members.
Roles & PermissionsWho can do what.
API KeysMachine credentials and scopes.
Integrations
Section titled “Integrations”WebhooksReceive events in your own systems.
Recipes & Workflows
Section titled “Recipes & Workflows”Task-oriented playbooks for common setups — each links back to the feature pages for detail.
Translator + Reviewer WorkflowTwo-stage flow: translators draft, reviewers approve.
Staging → ProductionSeparate environments to test strings before users see them.
CI/CD IntegrationWire Comvi into build and release pipelines.