Skip to main content
Tolk fits into the usual development flow: keys go from the code to Tolk, and translations come back into the repository as files. Translations therefore live in git, and a deploy never depends on Tolk.
1

Push

A developer adds keys in the source language and pushes them to Tolk, with php artisan tolk:push or from CI on a merge to main.
2

Translate

In Tolk, someone starts an AI translation of the new keys; translators review them in the editor.
3

Pull

Once a language is fully translated, Tolk sends the language.completed webhook. A GitHub Action fetches the files and opens a pull request.
4

Deploy

After the merge, the project deploys as usual. Tolk does not need to be reachable for that.

The building blocks

API v1

REST API at https://api.tolk.every-day.io/v1 with project tokens.

Authentication

Project tokens with the scopes read and write.

Syncing keys

A push in two steps: first a diff of hashes, then only what is new or changed.

Imports and exports

Upload files and fetch export profiles with an ETag.

Laravel package

tolk:push and tolk:pull from your Laravel project.

GitHub Action

A pull request, automatically, on language.completed.

Webhooks

Payloads and verifying the HMAC signature, in PHP and Node.

What the API cannot do

By design, you start an AI translation only in Tolk itself, not through the API, the package or CI. An AI run costs money and should be a deliberate choice.