Skip to main content

The public API

transglot has a versioned HTTP API that does everything the command line tool does, authenticated with a project deploy token.

transglot has a versioned HTTP API that does everything the command line tool does, authenticated with a project deploy token.

Who this is for

Developers. Minting the token needs admin on the project.

What happens next

The API is scoped to a single project (the token decides which) and covers the whole loop:

  • push source strings in, and pull translations out;

  • ask for project information and the list of batches, and retry a failed one;

  • start a translation run or a quality check;

  • publish a locale to the CDN;

  • read, write, import, export and extract the glossary;

  • list, create and delete webhook subscriptions, and browse the event catalogue with sample payloads.

Each endpoint requires a specific ability on the token, so a token minted only to pull cannot push, and neither can start a translation. Errors come back in a standard machine-readable problem format rather than as prose, so a client can branch on them.

Requests are rate limited, and a workspace that is suspended or pending deletion is refused on every method, reads included.

Related

  • Create a deploy token

  • The command line tool

  • Webhooks

Did this answer your question?