API Reference
1.1

Supertext Order API

Introduction

The Supertext Order API lets you place and manage professional (human) translation orders: upload content, request a quote, create orders, receive a completion callback, and download the finished translation.

This is the Basic-auth Order API. All endpoint paths are relative to the environment base URL.

Authentication

The Order API uses HTTP Basic authentication:

  • username = your Supertext account email
  • password = your Order API Key (from your Supertext account settings)

Send it on every request as an Authorization header:

Authorization: Basic BASE64("email:orderApiKey")

Environments

All environments live under supertext.com:

  • Production (live) — https://www.supertext.com
  • Staging — https://staging.supertext.com
  • Testing — https://testing.supertext.com

Use Staging or Testing for integration work; those orders are not billed and not translated by humans.

Order flow

  1. (optional) Verify credentials with Account check.
  2. Upload the content with Upload a file to get a DocumentId (or send it inline).
  3. Create the order(s) with Create an order — one order per target language.
  4. Supertext POSTs the completed order(s) to your CallbackUrl when finished.
  5. Download the Final file(s).

Order types & delivery

OrderTypeConfigurationId selects the product/quality tier and is account-specific (e.g. 166 BASIC, 167 PREMIUM, 168 CREATIVE). DeliveryId selects speed: 1 = Express, 2 = 24h, 3 = 48h, 4 = 3 days, 5 = 1 week.

Server
https://www.supertext.com
AuthenticationOptional
Name:Authorization
Value:

Account

Credential verification

GET/api/v1/translation/accountcheck

Verify credentials

Add your API key to send requests

Files

Upload and download documents

POST/api/v1/files/files

Upload a document to translate

Add your API key to send requests

Supported: DOCX, PPTX, XLSX, PDF, HTML, TXT, SRT

GET/api/v1/files/files/{orderId}

List files for an order

Add your API key to send requests
GET/storage/file/{fileId}/{fileName}

Download a file

Download a document by id (e.g. the finished 'Final' file). Older integrations may use /filedownloads/file/{fileId}/{fileName}.

Add your API key to send requests

Orders

Quotes, orders, status and feedback

POST/api/v1/translation/quote

Get a quote

Returns the word count, price, and available delivery options (with prices and delivery dates) for the given content, without placing an order. Upload the content first and reference it via Files (or send it inline via Groups). Select the product with OrderTypeConfigurationId + OrderTypeId.

application/json
200
Add your API key to send requests
Editable
POST/api/v1.1/translation/order

Create an order

Place a translation order. Returns one order object per target language. If CallbackUrl is set, Supertext POSTs the completed order object(s) to it when finished.

application/json
Add your API key to send requests
Editable
GET/api/v1/order/{orderId}

Get an order

Fetch a single order with its current status and files.

200
Add your API key to send requests
PATCH/api/v1/order/{orderId}

Update an order

Change the briefing, the requested deadline or the delivery speed of an order that already exists, using an RFC 6902 JSON Patch document. The body is an array of operations; path is a slash plus the property name in PascalCase, exactly as GET /api/v1/order/{orderId} returns it.

Access

With a standard Order API account you can update the cost centre of your own orders. The other paths below are writable through the same endpoint but need the internal Administrator role, so your account receives 403 Forbidden for them. Ask your Supertext contact if you need one of those changed.

On your own account use only replace, add or remove. move and copy are rejected with 403, because their from path would reach a field you may not change.

Paths you can update

  • /CostCenter (string, max 100 characters) - your cost centre, carried onto the invoice.

Paths that need the Administrator role

  • /OrderName (string, max 100 characters) - the order title shown in Supertext and on the invoice.
  • /AdditionalInformation (string) - free-text instructions for the translator.
  • /Background (string) - background and purpose of the text.
  • /TargetAudience (string) - who will read the translation.
  • /Deadline (string) - requested delivery date, ISO 8601, e.g. 2026-07-20T10:00:00Z. A value that cannot be parsed as a date clears the deadline.
  • /DeliveryId (integer) - delivery speed: 1 Express, 2 24 hours, 3 48 hours, 4 3 days, 5 1 week.
  • /IndustryId (integer) - subject area. Valid ids: GET /api/v1/util/industries.
  • /TextTypeId (integer) - text type. Valid ids: GET /api/v1/util/texttype.
  • /TextStyleId (integer) - writing style. Ids are product specific - ask Supertext.
  • /Links (array of { Url, Comment }) - reference links for the translator. Replaces the whole list.
  • /RecalculateDeadline - not a field on the order: including this operation makes Supertext recompute Deadline from the order's delivery option, respecting business hours. It overrides any /Deadline sent in the same request.

Important

  • Changing /DeliveryId or /Deadline does not reprice the order, and does not reschedule work that is already in production.
  • Only the paths above are written to the order. On a standard account anything else is rejected with 403; with the Administrator role an unlisted property is instead accepted and silently ignored - a 204 does not mean the value was stored. Either way CallbackUrl, ReferenceData, ContentType, Groups and Files cannot be changed after the order is created, and the status has its own endpoint (PUT /api/v1/order/status/{orderId}/{statusId}).
  • Every change is written to the order's history, but nobody is notified. For a change to an order that is already being translated, contact Supertext.
application/json
Add your API key to send requests
Editable
POST/api/v1/order/feedback

Provide feedback / reject an order

application/json
Add your API key to send requests
Editable
PUT/api/v1/order/status/{orderId}/{statusId}

Change an order's status

Set an order's status. Commonly used to mark an order as Collected (statusId = 9).

Add your API key to send requests
GET/api/v1/customer/orders/current/{pageSize}/{page}/{personId}

List the current person's orders

Add your API key to send requests