Manual
CLI
API
Log in Get started free

Endpoints

Every route of the API, grouped by area.

All routes are relative to https://api.continuous-translations.com. {id} is the id of the resource, {lang} a language code.

Authentication #

RoutePurpose
POST /auth/registerCreate an account
POST /auth/loginGet a session token
POST /auth/logoutEnd the session
GET /auth/meThe current user
POST /auth/request-password, POST /auth/reset-passwordReset a password
GET /auth/invites/{token}, POST /auth/invites/{token}/acceptAccept an invite

Account and organisation #

AreaRoutes
AccountGET/PUT/DELETE /account, PUT /account/password, GET /account/billing
SessionsGET /account/sessions, DELETE /account/sessions/{id}
NotificationsGET/PUT /account/notifications
API keysGET/POST /account/api-keys, DELETE /account/api-keys/{id}
OrganisationGET/PATCH/DELETE /org, POST /org/transfer, GET /org/audit
MembersGET /org/members, PATCH/DELETE /org/members/{userId}, POST /org/invites, DELETE /org/invites/{id}
TeamsGET/POST /teams, PATCH/DELETE /teams/{id}, POST /teams/{id}/members

Projects #

RoutePurpose
GET/POST /projectsList and create projects
GET/PATCH/DELETE /projects/{id}Read, change and delete a project
POST /projects/{id}/archive, unarchive, duplicateArchive, restore and copy
GET/POST /projects/{id}/languagesLanguages of a project
PATCH/DELETE /projects/{id}/languages/{code}Change or remove a language
GET/POST /projects/{id}/membersProject members
GET/POST /projects/{id}/teamsTeams with access
GET /projects/{id}/activityRecent activity
GET/PUT /projects/{id}/settingsProject settings
GET/POST /projects/{id}/webhooks, DELETE .../webhooks/{id}Webhooks

Branches, keys and translations #

RoutePurpose
GET /branchesList branches
POST /projects/{id}/branchesCreate a branch
PATCH /branches/{id}Freeze or unfreeze: { "frozen": true }
POST /branches/{id}/mergeMerge a branch
DELETE /branches/{id}Delete a branch
GET/POST /branches/{id}/keysKeys on a branch
GET /branches/{id}/review?language=Translations waiting for review
GET/PATCH/DELETE /keys/{id}Read, change and delete a key
POST /keys/{id}/notesAdd a note to a key
PUT /keys/{id}/translations/{lang}Write a translation: { "value": "...", "submit": true }
POST /keys/{id}/translations/{lang}/approveApprove a translation
POST /keys/{id}/translations/{lang}/request-changesAsk for changes
POST /keys/{id}/translations/{lang}/commentsComment on a translation

CLI and CI #

These routes accept API keys and are what the CLI uses.

RoutePurpose
POST /projects/{id}/pushSend source strings: { "branch", "keys", "prune?", "translations?" }
GET /projects/{id}/pull?language=&branch=&status=Get translations, see Pull translations
GET /projects/{id}/status?branch=Completion per language
POST /projects/{id}/mergeMerge a branch: { "branch" }
GET/POST /projects/{id}/api-keys, DELETE .../{id}Project keys

Translation memory and glossary #

RoutePurpose
GET /tm?language=&q=Search the translation memory
GET /tm/statsTranslation memory statistics
POST /tm/{id}/use, DELETE /tm/{id}Use or remove an entry
GET/POST /glossary, PATCH/DELETE /glossary/{id}Glossary terms
PUT /glossary/{id}/translations/{lang}Translate a glossary term

Repository integrations #

GitHub and GitLab connections have their own routes under /integrations/github and /integrations/gitlab, plus PUT /projects/{id}/repository/github, PUT /projects/{id}/repository/gitlab, and GET/DELETE /projects/{id}/repository.