v3 · 271 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

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.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

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.Project and task statusesWhat each project and task status means, which changes the API accepts, and how they map to the statuses of other platforms.Workflow steps and templatesA project's work units run through workflow steps, such as translation and review. The account keeps the catalog of steps. An org unit keeps workflow templates: named, ordered lists of steps that its projects reuse. This guide sets up both and then creates a project that uses them.Work packagesA work package sends work units from a project in your account to a vendor that has its own wxrks account. The vendor works on a copy of the project in its account. When the vendor delivers, the translations come back to your project.Tracking long-running operationsMany calls start work that goes on after they answer: ingesting a project's files, building an export kit, importing a bilingual file, running a logfile. Each of these operations has its own status call, with the details that belong to it. Get Operation Status reports any of them in the same terms, so an integration can poll them all the same way.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.TM per workflow stepA translation memory bound to a project, or associated with an org unit, is read and written by every workflow step by default, as its 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 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 endpointsProjects99 endpointsTasks16 endpointsLogfiles10 endpointsOperations1 endpointTranslation Memory13 endpointsGlossary23 endpointsOrg Units12 endpointsOrganization3 endpointsUsers10 endpointsNet Rate3 endpointsPrice List1 endpointWorkflows5 endpointsWork Packages11 endpointsCustom Fields3 endpointsAccounting15 endpointsIntegrations18 endpointsWebhooks9 endpointsNotification Templates3 endpointsPermission9 endpointsPortal3 endpointsDelivery Packaging1 endpointReporting1 endpointWebhook payloads26 requests