v3 · 200 endpoints

wxrks API

base url: https://app.wxrks.com
auth: X-AUTH-TOKEN header
spec: openapi.json

The wxrks API lets your systems create translation projects, move files in and out of them, follow their progress, and manage what surrounds them: glossaries, translation memories, org units, users, costs and payables.

Every endpoint here is generated from the code that serves it, so the paths, parameters and fields are the ones the API accepts and returns. The guides tell you which endpoints to call, in what order, and what comes back.

Start here

Follow the Quickstart: eleven steps from a file on your machine to delivered translations. Core concepts explains the objects and settings it works with.

Two things to know up front

Quote Automation changes the flow. With it on, the platform quotes the project and moves it DRAFT → PENDING itself; with it off, the project waits in DRAFT and your own transition runs the quote. Read the actual status rather than assuming one (see Quote Automation).

The translating happens in the editor. The API sets the work up, hands it out and reports on it; people confirm the text in the editor, and a task is ready to deliver once they have.

Ways in

HTTP: call the endpoints from any language, as the Quickstart does.
The wx CLI: every endpoint as a command, for terminals, scripts and CI pipelines. See wx CLI.
MCP: translation, translation memory and terminology tools for AI assistants such as Claude and Cursor. See MCP server.

Changes

Every change to these endpoints is checked for breaking changes before it is merged, and each release's changes are listed in the changelog.

Get started

QuickstartThe whole path, end to end: a file from your machine becomes a translated file, reviewed by people, delivered.Core conceptsThe object model, how settings resolve, what each project status allows, and the asynchronous pattern behind every long-running call. Read this once: the Quickstart and the guides assume it.AuthenticationEvery call sends a token in the X-AUTH-TOKEN header. You get the token by exchanging an API user's access key and secret.PaginationList endpoints return one page of items at a time. Ask for the next page until the response says it is the last one.ErrorsA call that fails answers with an HTTP error status and a wxrks error code that says what kind of failure it was.

Guides

Projects from files (CI API)Send files from a repository or a build pipeline in one call, and let wxrks find or create the project and its work units.Bilingual file round tripExport one work unit as a bilingual XLIFF file, change its translations in your own system (for example with machine translation or an AI review), and import the file back into the same work unit.Segments and locksRead a project's segments with their translation status and lock state, lock or unlock them, and read or add the comments on them, as in the editor.TM updatesKeep a translation memory outside wxrks in sync: each time a work unit is delivered, download as TMX the translation memory entries that work unit saved, and import them into your own system.WebhooksHave wxrks call your server when projects, tasks, work units, org units or users change, instead of polling for changes.

CLI

wx CLIwx is the wxrks command-line interface. It has a command for every endpoint in this reference, signs in for you, and runs the wxrks MCP server.Install wxwx is a single native binary for macOS, Linux and Windows. Install it with a package manager, or download it from the latest release.Configure wxwx signs in with an API user's access key and secret, saved in a profile or passed in environment variables. See Authentication for API users.CommandsEvery command calls one endpoint of this reference, in the form wx <group> <command> [arguments] [flags].wx in CI pipelinesSend source files to wxrks from a build pipeline, with the API user's credentials kept in the pipeline's secrets.

MCP

MCP serverThe wxrks MCP server gives AI assistants such as Claude, Cursor and opencode tools to translate with your translation memories and glossaries, find existing translations, and check terminology and quality.Connect a clientRegister wx mcp as a local (stdio) MCP server in your client. It signs in with the default profile saved by wx init, or with the BW_HOST, BW_ACCESS_KEY and BW_SECRET environment variables (see Configure wx).ToolsThe tools the wxrks MCP server offers, with their arguments. Locales are wxrks locale codes, such as en_us or pt_br.

Reference

Authentication and Reference2 endpoints Projects74 endpoints Tasks10 endpoints Logfiles10 endpoints Translation Memory13 endpoints Glossary23 endpoints Org Units3 endpoints Organization3 endpoints Users10 endpoints Net Rate3 endpoints Price List1 endpoint Workflows1 endpoint Custom Fields3 endpoints Accounting13 endpoints Integrations18 endpoints Webhooks1 endpoint Permission9 endpoints Portal3 endpoints