API reference
Every endpoint of the transglot REST API and every webhook event, with request and response examples.
The reference is generated from the API's OpenAPI document, so each page shows the exact parameters, request body, responses and errors of one operation. For how the API behaves as a whole (authentication, errors, rate limits, versioning), start with the REST API overview.
Base URL and authentication
curl https://api.transglot.ai/v1/project \
-H "Authorization: Bearer $TRANSGLOT_TOKEN"Every request under /v1 sends a project deploy token as a bearer token. The token decides which project the request acts on, so no URL carries a workspace or project identifier. Each operation needs one ability on the token, shown on its page. The two CDN read operations take a CDN key instead.
Bodies are JSON unless an operation says otherwise. Errors use the problem format described in Errors, and a rate-limited request answers 429 with a Retry-After header (Rate limits). API access needs the Starter plan or higher.
Sections
Project
The project the token belongs to, its languages and their progress.
Push and pull
Upload a locale file into the project, and download a locale as a file.
Translation
Start an AI translation run with Glossa.
Batches
Watch, retry and cancel translation runs.
Single values
Read and write individual translation values by key name.
Quality
Start a quality check over translated strings.
CDN
Publish a locale as a runtime bundle, and read published bundles with a CDN key.
Glossary
List, create, update, delete, import, export and extract glossary terms.
Webhooks
Manage webhook endpoints, and every event payload transglot sends.
Download the spec
The OpenAPI 3.1 document behind these pages is published at /openapi/transglot-v1.yaml. Import it into an API client or a code generator to work against the API with typed requests.