get started
Versioning
Each endpoint carries its version in its path. Most of the API is under /api/v3, and a few resources are under /api/v1 or /api/v2.
Endpoints under v1 and v2
These endpoints are current, supported and stable. None of them is deprecated, and no v3 endpoint does what they do. They take the same X-AUTH-TOKEN and follow the same conventions as the v3 endpoints.
| Resource | Version | Endpoints |
|---|---|---|
| Translation units | v1 | Search Translation Units, Fuzzy Search Translation Units, Fuzzy Search Segments, Upsert Translation in TU, Update Translation in TU, Delete Translation Unit (TU), Delete Translation in TU |
| Translation memories | v1 | List Translation Memory (TM), Import TM File, Export TM, Get TM Job |
| File params | v1 | Get File Params |
| Organizations | v2 | List Organizations, Create Organization, Get Organization |
| Permission groups | v2 | List Permission Groups, Create Permission Group, Get Permission Group, Update Permission Group, Add User to Permission Group, Remove User from Permission Group |
| Permissions | v2 | List Permissions, Grant Permission for Grantee, Revoke Permission for Grantee |
Some v3 endpoints work next to these without replacing them. Get Project Translation Memories lists only the memories bound to one project, with their settings there; to list or search the account's memories, use List Translation Memory (TM).
Changes
Every change to an endpoint, whatever its version, is checked for breaking changes before it is merged. Each release's changes are listed in the changelog, breaking changes first.