v3 · 271 endpoints
wxrks API
- base url
https://app.wxrks.com- auth
X-AUTH-TOKENheader- 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.
- The OpenAPI spec: openapi.json is the file to import into an API client such as Postman, Insomnia, Bruno or Hoppscotch, or to feed a client generator. It is the same spec these pages are built from, so every endpoint arrives with its parameters, schemas and examples.
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
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.LimitsHow large a request can be, how long a call can take, how many calls you can make, and how to match a call to a record on your side.VersioningEach endpoint carries its version in its path. Most of the API is under /api/v3, and a few resources are under /api/v1 or /api/v2.Guides
read and write say. To have a step behave differently, for example a translation step that reads the TM and a review step that also writes to it, list the steps in settings.workflows.Searching a translation memorySearch Translation Units finds the translation units of a translation memory by their source text, and returns them with their translation in targetLocale.WebhooksHave wxrks call your server when projects, tasks, work units, logfiles, org units or users change, instead of polling for changes.CLI
wx 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
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.