Sleekdocs Translate API

Who am I

GET /v1/api/translate/me Any key

The caller, and for an API key its team, scopes, project limit and expiry. Use it to check what a key may do before trying.

Answer

{
  "data": {
    "user": {
      "uuid": "e8767d89-28db-4305-895e-4129f4f299b3",
      "email": "anna@example.com",
      "name": "Anna Berg"
    },
    "team": {
      "uuid": "1dd96084-3b09-4098-8bf1-b6348362e98e",
      "name": "Example AB"
    },
    "key": {
      "uuid": "e45739df-487b-4448-bdd4-af9359f5836d",
      "name": "CI pipeline",
      "scopes": [
        "read",
        "write"
      ],
      "projectUuid": "d6523c38-886e-47b4-9542-e7ba062d1078",
      "expiresAt": "2026-11-14T19:33:45Z"
    }
  }
}

List projects

GET /v1/api/translate/projects Scope read

The projects in the caller's team, with how much of each language is translated. An API key lists its own team, or only its project if it is limited to one; a signed-in user names the team with team.

Answer

{
  "data": [
    {
      "uuid": "d6523c38-886e-47b4-9542-e7ba062d1078",
      "name": "Storefront",
      "primaryLanguage": "en",
      "keys": 387,
      "languages": [
        {
          "code": "en",
          "name": "English",
          "primary": true,
          "translated": 387,
          "untranslated": 0
        },
        {
          "code": "sv",
          "name": "Swedish",
          "primary": false,
          "translated": 382,
          "untranslated": 5
        }
      ]
    }
  ]
}

Get a project

GET /v1/api/translate/projects/{projectUuid} Scope read

A project's languages and counts, each language's latest revision and unpublished changes, and which revision is deployed in each environment.

Answer

{
  "data": {
    "uuid": "d6523c38-886e-47b4-9542-e7ba062d1078",
    "name": "Storefront",
    "primaryLanguage": "en",
    "fileFormat": "JSON_FLAT",
    "keys": 387,
    "languages": [
      {
        "code": "en",
        "name": "English",
        "primary": true,
        "translated": 387,
        "untranslated": 0,
        "latestRevision": 18,
        "unpublishedChanges": 0,
        "deployed": {
          "DEV": 18,
          "TEST": 18,
          "PROD": 17
        }
      },
      {
        "code": "sv",
        "name": "Swedish",
        "primary": false,
        "translated": 382,
        "untranslated": 5,
        "latestRevision": 10,
        "unpublishedChanges": 3,
        "deployed": {
          "DEV": 10,
          "TEST": 10,
          "PROD": 10
        }
      }
    ]
  }
}

List keys and texts

GET /v1/api/translate/projects/{projectUuid}/keys Scope read

Every key with its texts in the working copy, optionally filtered by language, status and a search.

Answer

{
  "data": [
    {
      "key": "checkout.title",
      "values": {
        "en": "Checkout",
        "sv": "Kassa"
      }
    },
    {
      "key": "checkout.pay_now",
      "values": {
        "en": "Pay now",
        "sv": null
      }
    }
  ]
}

Add or update keys and texts

PATCH /v1/api/translate/projects/{projectUuid}/keys Scope write

Adds or updates up to 1,000 keys and their texts in the working copy, in one call. upsert adds new keys and changes texts; create-only adds new keys and leaves existing ones alone. With dryRun nothing is written and the answer says what would change. A null text leaves that language as it is. Adding keys also needs the keys scope.

Request body

{
  "mode": "upsert",
  "dryRun": false,
  "items": [
    {
      "key": "checkout.title",
      "values": {
        "en": "Checkout",
        "sv": "Kassa"
      }
    },
    {
      "key": "cart.empty",
      "values": {
        "sv": "Din varukorg är tom"
      }
    }
  ]
}

Answer

{
  "data": {
    "dryRun": false,
    "created": [
      "checkout.title"
    ],
    "updated": [
      "cart.empty"
    ],
    "unchanged": [
      "account.sign_out"
    ],
    "skipped": []
  }
}

Rename a key

POST /v1/api/translate/projects/{projectUuid}/keys/rename Scope keys

Renames a key in every language, keeping its texts.

Request body

{
  "from": "checkout.title",
  "to": "checkout.heading"
}

Answer

{
  "data": {
    "key": "checkout.heading"
  }
}

Delete a key

DELETE /v1/api/translate/projects/{projectUuid}/keys/{key} Scope keys

Deletes a key and its texts in every language.

Answer

{
  "data": null
}

Download a file

GET /v1/api/translate/projects/{projectUuid}/languages/{languageCode}/file Scope read

A language as a JSON file, the same shape your app loads from the CDN. By default the working copy in the project's file format.

Answer

{
  "checkout.title": "Kassa",
  "checkout.pay_now": "Betala nu"
}

Import a file

PUT /v1/api/translate/projects/{projectUuid}/languages/{languageCode}/file Scope write

Imports a JSON file, nested or flat, into a language's working copy. update changes the texts in the file and leaves the rest; replace also removes texts for keys the file doesn't have. With dryRun nothing is written. The answer lists the changes. A file that adds keys also needs the keys scope.

Request body

{
  "checkout": {
    "title": "Kassa",
    "pay_now": "Betala nu"
  }
}

Answer

{
  "data": {
    "dryRun": false,
    "mode": "UPDATE",
    "changes": {
      "nCreated": 1,
      "nUpdated": 0,
      "nDeleted": 0,
      "nUnchanged": 1,
      "nNewKeys": 1,
      "created": [
        {
          "key": "checkout.title",
          "oldValue": "",
          "newValue": "Kassa",
          "newKey": true
        }
      ],
      "updated": [],
      "deleted": []
    }
  }
}

Compare revisions

GET /v1/api/translate/projects/{projectUuid}/languages/{languageCode}/diff Scope read

What was added, changed and removed between two revisions of a language, or between a revision and the working copy. By default, from the latest published revision to the working copy: what publishing would release.

Answer

{
  "data": {
    "nCreated": 1,
    "nUpdated": 1,
    "nDeleted": 0,
    "nUnchanged": 380,
    "nNewKeys": 0,
    "created": [
      {
        "key": "account.orders",
        "oldValue": "",
        "newValue": "Mina beställningar",
        "newKey": false
      }
    ],
    "updated": [
      {
        "key": "checkout.pay_now",
        "oldValue": "Betala",
        "newValue": "Betala nu",
        "newKey": false
      }
    ],
    "deleted": []
  }
}

Publish languages

POST /v1/api/translate/projects/{projectUuid}/publish Scope publish

Saves each chosen language's working copy as its next revision. "changed" (the default) publishes every language with unpublished changes; or list language codes. Languages without changes are skipped. The key's owner also needs a deploy right in the team.

Request body

{
  "languages": "changed"
}

Answer

{
  "data": {
    "published": [
      {
        "language": "sv",
        "revision": 11
      }
    ],
    "skipped": [
      {
        "language": "en",
        "reason": "NO_CHANGES"
      }
    ]
  }
}

Deploy languages

POST /v1/api/translate/projects/{projectUuid}/deploy Scope deploy:<env>

Puts a revision of each chosen language on the CDN for one environment, at https://cdn.sleekdocs.com/<project>/<env>/<language>.json, in the project's file format. languages is "all" (the default) or a list of codes; revision is "latest" (the default) or a number, which needs exactly one language. A language already at that revision is skipped (ALREADY_DEPLOYED), one never published too (NEVER_PUBLISHED). A failed upload is reported in failed and doesn't undo the others. Needs the deploy:<env> scope and the owner's deploy right for that environment.

Request body

{
  "env": "test",
  "languages": "all",
  "revision": "latest"
}

Answer

{
  "data": {
    "env": "TEST",
    "deployed": [
      {
        "language": "sv",
        "revision": 11
      }
    ],
    "skipped": [
      {
        "language": "en",
        "reason": "ALREADY_DEPLOYED"
      }
    ],
    "failed": []
  }
}