> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tolk.every-day.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview for developers

> Connect your project to Tolk with the API, the Laravel package, a GitHub Action and webhooks.

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.

## The recommended workflow

<Steps>
  <Step title="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`.
  </Step>

  <Step title="Translate">
    In Tolk, someone starts an AI translation of the new keys; translators review them in the editor.
  </Step>

  <Step title="Pull">
    Once a language is fully translated, Tolk sends the `language.completed` webhook. A GitHub Action fetches the files and opens a pull request.
  </Step>

  <Step title="Deploy">
    After the merge, the project deploys as usual. Tolk does not need to be reachable for that.
  </Step>
</Steps>

## The building blocks

<Columns cols={2}>
  <Card title="API v1" icon="server" href="/api-reference/introduction">
    REST API at `https://api.tolk.every-day.io/v1` with project tokens.
  </Card>

  <Card title="Authentication" icon="key" href="/developers/authentication">
    Project tokens with the scopes `read` and `write`.
  </Card>

  <Card title="Syncing keys" icon="arrows-rotate" href="/developers/syncing-keys">
    A push in two steps: first a diff of hashes, then only what is new or changed.
  </Card>

  <Card title="Imports and exports" icon="file-export" href="/developers/imports-and-exports">
    Upload files and fetch export profiles with an ETag.
  </Card>

  <Card title="Laravel package" icon="laravel" href="/developers/laravel-package">
    `tolk:push` and `tolk:pull` from your Laravel project.
  </Card>

  <Card title="GitHub Action" icon="github" href="/developers/github-action">
    A pull request, automatically, on `language.completed`.
  </Card>

  <Card title="Webhooks" icon="webhook" href="/developers/webhooks">
    Payloads and verifying the HMAC signature, in PHP and Node.
  </Card>
</Columns>

## 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.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.