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 platform Create a project, add languages and keys, translate, and publish — without writing any app code.
Connect an app Load 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 Concepts Projects, languages, keys, namespaces, and how they relate.
Your First Project End-to-end walkthrough from empty account to a live CDN URL.
Consume Translations Load 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.
Projects Create and configure projects.
Languages Source and target languages, locale codes.
Translations The editor, statuses, history, comments.
Translation Lifecycle How values move from untranslated to translated, and how publish fits in.
Namespaces Group keys for code-splitting and organization.
Import & Export Bulk file I/O and migration from other TMS.
CDN Deployment Publish and serve translations from the edge.
Productivity
Section titled “Productivity”Tools that speed up translation work without sacrificing quality.
Machine Translation DeepL, Google, OpenAI, Anthropic, and when to use which.
Translation Memory Reuse previous translations across projects.
Glossaries Enforce consistent terminology.
Team & Access
Section titled “Team & Access” Team Management Invite and manage members.
Roles & Permissions Who can do what.
API Keys Machine credentials and scopes.
Integrations
Section titled “Integrations” Webhooks Receive 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 Workflow Two-stage flow: translators draft, reviewers approve.
Staging → Production Separate environments to test strings before users see them.
CI/CD Integration Wire Comvi into build and release pipelines.