# Tolk > Documentation for Tolk, the translation platform of Every Day: user guide, developer guide and API reference. - [What is Tolk?](https://docs.tolk.every-day.io/index.md): The translation platform of Every Day: all translations of all your projects in one place. - [Signing in](https://docs.tolk.every-day.io/getting-started/signing-in.md): Every Day colleagues sign in with Microsoft; external users with email, password and two-factor authentication. - [Roles and permissions](https://docs.tolk.every-day.io/getting-started/roles-and-permissions.md): Permissions apply per project: Manager, Developer or Translator. - [Concepts](https://docs.tolk.every-day.io/getting-started/concepts.md): The terms you come across in Tolk and in this documentation. - [Projects](https://docs.tolk.every-day.io/guide/projects.md): Create, configure, archive and delete a project. - [Languages](https://docs.tolk.every-day.io/guide/languages.md): Add target languages, set fallbacks and change the source language. - [Team](https://docs.tolk.every-day.io/guide/team.md): Add people to a project, choose their role and limit translators to certain languages. - [Editor](https://docs.tolk.every-day.io/guide/editor.md): Translate per language, with autosave, filters, search and bulk actions. - [Placeholders](https://docs.tolk.every-day.io/guide/placeholders.md): How Tolk prevents a translation from breaking a placeholder. - [Tags](https://docs.tolk.every-day.io/guide/tags.md): Group keys, for example per screen or per release. - [Glossary](https://docs.tolk.every-day.io/guide/glossary.md): Fixed translations of terms, and terms that are never translated. - [Translating with AI](https://docs.tolk.every-day.io/guide/ai-translation.md): A first version of your translations with AI, with the glossary, a style instruction and a cost estimate up front. - [Importing](https://docs.tolk.every-day.io/guide/importing.md): Read in existing language files, with a preview first. - [Exporting and export profiles](https://docs.tolk.every-day.io/guide/exporting.md): Download translations as files for your project, with fixed profiles or a format of your own. - [API tokens](https://docs.tolk.every-day.io/guide/api-tokens.md): Tokens that let the Laravel package, CI and scripts talk to one project. - [Webhooks](https://docs.tolk.every-day.io/guide/webhooks.md): Let Tolk tell another service that something has changed. - [Your customer](https://docs.tolk.every-day.io/guide/customer-settings.md): Switch between customers and keep your customer's details and AI settings up to date. - [Plan and usage](https://docs.tolk.every-day.io/guide/plan-and-usage.md): Your plan sets limits on keys, projects, users and the AI budget. See how much you use and what happens at a limit. - [Overview for developers](https://docs.tolk.every-day.io/developers/overview.md): Connect your project to Tolk with the API, the Laravel package, a GitHub Action and webhooks. - [Authentication](https://docs.tolk.every-day.io/developers/authentication.md): Every request uses a project token as a bearer token. - [Conventions](https://docs.tolk.every-day.io/developers/conventions.md): Base URL, JSON envelope, errors, conflicts and pagination. - [Syncing keys](https://docs.tolk.every-day.io/developers/syncing-keys.md): A push in two steps: first compare with hashes, then send only what is new or changed. - [Imports and exports through the API](https://docs.tolk.every-day.io/developers/imports-and-exports.md): Upload files, fetch export profiles with an ETag and follow jobs. - [Laravel package](https://docs.tolk.every-day.io/developers/laravel-package.md): Push keys and fetch translations with tolk:push and tolk:pull. - [GitHub Action](https://docs.tolk.every-day.io/developers/github-action.md): Automatically get a pull request with new translations as soon as a language is fully translated. - [Receiving webhooks](https://docs.tolk.every-day.io/developers/webhooks.md): Payloads, headers and verifying the HMAC signature, with examples in PHP and Node. - [API reference](https://docs.tolk.every-day.io/api-reference/introduction.md): All endpoints of the Tolk API v1, generated from the OpenAPI document. - [Download an export](https://docs.tolk.every-day.io/api-reference/exports/download-an-export.md): The export of a profile (`GET /v1/project` lists them) in the languages of `locales` (a comma list; default: the languages of the profile, else every language of the project), with `missing` deciding what a missing translation becomes (default: the choice of the profile). The answer is the file with… - [Import files](https://docs.tolk.every-day.io/api-reference/imports/import-files.md): Uploads translation files (`multipart/form-data`, `files[]`: JSON, PHP, PO, MO, CSV, XLSX, XLIFF or a zip of them) and imports them without a preview, as dialog 10 would after confirming: the format, namespace and language are recognised from each path unless the request forces them. A file that is… - [Get a job](https://docs.tolk.every-day.io/api-reference/jobs/get-a-job.md): An import (`POST /v1/imports`) or export (`GET /v1/exports/{profileKey}`) job of the project: its status (`queued`, `running`, `succeeded`, `failed`), its progress, its result once it succeeded and the reason once it failed. Poll it until it is `succeeded` or `failed`; for an export, fetch the expor… - [List the keys](https://docs.tolk.every-day.io/api-reference/keys/list-the-keys.md): One page of the keys of the project, ordered by their id, with the cursor of the next page. Filters on namespace, tag name (`untagged`: keys without a tag), archived state and last change. - [Update a key](https://docs.tolk.every-day.io/api-reference/keys/update-a-key.md): Changes the description, the maximum length or the tags (the new set) of the key with this hash. A field that is left out stays as it is; `null` clears the description or the maximum length. - [Compare key hashes](https://docs.tolk.every-day.io/api-reference/keysdiff/compare-key-hashes.md): Tells which of the sent hashes are new, changed (another source hash), archived or unchanged, without changing anything. - [Synchronise keys](https://docs.tolk.every-day.io/api-reference/keyssync/synchronise-keys.md): Creates and updates the sent keys with their source text and archives the sent hashes. Tags are added, never removed. A key that would change between singular and plural is refused per item (`plural_changed`). The same sync twice changes nothing the second time. When the new and restored keys would… - [Get the project](https://docs.tolk.every-day.io/api-reference/project/get-the-project.md): The project of the token: its slug, name and type, the source locale, the content version and the languages (the source first). There is no project in the URL: the token decides. - [Get the progress per language](https://docs.tolk.every-day.io/api-reference/stats/get-the-progress-per-language.md): The counters of every language of the project (the source first): keys, translated, outdated, placeholder errors and the rounded percentage, plus the content version of the project. - [List the translations of a language](https://docs.tolk.every-day.io/api-reference/translations/list-the-translations-of-a-language.md): One page of the active keys of the project with their translation in this language, ordered by key id, also the keys without a translation yet (`value`, `forms` and `version` are then `null`). The source language can be read too. Filter on status, namespace, tag name (`untagged` for keys without a t… - [Write translations of a language](https://docs.tolk.every-day.io/api-reference/translations/write-translations-of-a-language.md): Writes at most one block of translations of a target language, overwriting (`overwrite`) or only filling empty ones (`fill_empty`). An empty `value` clears a translation; `version` refuses the item when the translation changed since it was read. Items that are not written come back in `skipped` with… ## OpenAPI Specs - [openapi](/api-reference/openapi.json) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.