API reference - Tolk

The endpoints in this tab come from the OpenAPI document of Tolk. With the Try it button you can call an endpoint directly with your own API token.

The endpoint pages are generated from the OpenAPI document. For an explanation of authentication, conventions, syncing keys and imports and exports, see Developers.

Base URL

https://api.tolk.every-day.io/v1

Authentication

curl https://api.tolk.every-day.io/v1/project \
  -H "Authorization: Bearer $TOLK_TOKEN"

See Authentication for scopes and error codes, and Conventions for the JSON envelope, errors, conflicts and pagination.

Endpoints

Method and path	Purpose	Scope
`GET /project`	Project, languages and export profiles	`read`
`GET /stats`	Progress per language	`read`
`GET /keys`	Keys with filters and pagination	`read`
`POST /keys/diff`	Compare hashes: which keys are new or changed	`write`
`POST /keys/sync`	Create, update, restore and archive keys	`write`
`PATCH /keys/{keyHash}`	Description, maximum length and tags of a key	`write`
`GET /translations/{locale}`	Translations of a language	`read`
`PUT /translations/{locale}`	Update translations in bulk	`write`
`POST /imports`	Import files (job)	`write`
`GET /exports/{profileKey}`	Download an export profile, with ETag	`read`
`GET /jobs/{jobId}`	Status of an import or export job	`read`

The OpenAPI document

The document is also available on its own in this site: /api-reference/openapi.json. Import it into Postman, Insomnia or a client generator, for example.