Node.js Library

The official TypeScript/Node.js package, @ollang-dev/sdk, doubles as a plain API client for the whole Ollang integration API — projects, uploads, orders, folders, revisions, translation memories, custom instructions, content, billing, locales and Figma — with full TypeScript types. This page covers that programmatic use; the Quick Start and Features pages cover the Asset Management UI and Browser SDK that ship in the same package. Source code lives in the SDK repository. Node.js 18+ is recommended.

Installation

npm install @ollang-dev/sdk

Authentication

Sign up or log in at Olabs
Create or select a project
Generate an API key from project settings

import { Ollang } from "@ollang-dev/sdk";

const ollang = new Ollang({ apiKey: process.env.OLLANG_API_KEY! });

Quick Start

import { readFile } from "node:fs/promises";
import { Ollang } from "@ollang-dev/sdk";

const ollang = new Ollang({ apiKey: process.env.OLLANG_API_KEY! });

// Upload a file (creates a project)
const upload = await ollang.uploads.direct({
  file: new Blob([await readFile("./video.mp4")]),
  filename: "video.mp4",
  name: "My Video",
  sourceLanguage: "en",
});

// Create an order
const order = await ollang.orders.create({
  orderType: "cc",
  level: 1,
  projectId: upload.projectId,
  targetLanguageConfigs: [
    { language: "fr", isRush: false },
    { language: "de", isRush: false },
  ],
});

// Check order status
const status = await ollang.orders.get(order.id);
console.log(status);

// Download links, once the order completes
for (const doc of status.orderDocs ?? []) {
  console.log(doc.type, doc.name, doc.url);
}

Ollang is a named export. It is also the default export, so import Ollang from "@ollang-dev/sdk" works too — but versions up to 0.4.0 only exported it by name, and the default import threw Ollang is not a constructor there. import { Ollang } works on every version.

Naming the uploaded file

The platform takes the stored file’s extension from the name the file is sent under, and rejects an upload it cannot get one from. A File carries its own name; a bare Blob does not, so pass filename alongside it:

await ollang.uploads.direct({
  file: new Blob([JSON.stringify(strings)]),
  filename: "en.json",
  name: "App strings",
  sourceLanguage: "en",
});

Blob with filename is the portable form. File is only a global from Node 20 onwards — on Node 18 new File(...) throws ReferenceError: File is not defined, and importing File from node:buffer is not a substitute here, as it does not satisfy the parameter’s TypeScript type. A global File works fine where it exists, and its own name is used when filename is omitted.

name is the display name for the created project. The extension is appended to it if it does not already end in one, so name: "App strings" above is stored as App strings.json.

Uploading VTT subtitles

Pass the source projectId returned by the upload and a name, rather than an order ID. The response contains projectId. Source language defaults to the project’s language; Node and Python also accept an explicit override.

const subtitles = await ollang.uploads.vtt({
  file: new Blob([await readFile('./subtitles.vtt')]),
  projectId: upload.projectId,
  name: 'Subtitles',
});
console.log(subtitles.projectId);

Resources

Resource	Description
`ollang.projects`	Create, read and list projects
`ollang.uploads`	Upload files, or register remote ones by URL
`ollang.orders`	Create, track, review and export orders
`ollang.folders`	Browse folders and act on all their orders at once
`ollang.revisions`	Request revisions on completed orders
`ollang.memories`	Translation memories and their items
`ollang.customInstructions`	Set custom translation instructions
`ollang.content`	Import and export translation units
`ollang.billing`	Credit wallet and consumption history
`ollang.locales`	Resolve and validate language codes
`ollang.figma`	Import Figma files and track their orders
`ollang.scans`	Scan sessions used by Asset Management
`ollang.cms`	CMS integration endpoints

All methods return typed, parsed JSON responses. Non-2xx responses reject with the underlying HTTP error, which carries the response status and body.

More Examples

// List orders with pagination and filters
const page = await ollang.orders.list({
  pageOptions: { page: 1, take: 20 },
  filter: { status: "completed" },
});
for (const order of page.data) {
  console.log(order.id, order.status);
}

// Request a revision on an order
await ollang.revisions.create("ORDER_ID", {
  type: "other",
  time: "00:01:23",
  description: "Fix the terminology in this segment",
});

// Custom instructions
await ollang.customInstructions.create({
  key: "tone",
  value: "Formal, brand-safe tone for all marketing content",
});

Resolve a language code

Order and project creation match language codes exactly, so resolve anything uncertain instead of guessing at a region subtag.

const matches = await ollang.locales.search("portu");
const check = await ollang.locales.validate("pt-PT");

Translation memories

const memory = await ollang.memories.create("Brand terms");

const job = await ollang.memories.importItems(memory.id, [
  {
    sourceLanguage: "en",
    targetLanguage: "fr",
    sourceText: "Sign in",
    targetText: "Se connecter",
  },
]);

// Importing is asynchronous — poll the job for progress
const progress = await ollang.memories.getImportJob(job.jobId);

// Reuse a memory when creating an order
await ollang.orders.create({
  orderType: "document",
  level: 1,
  projectId: "PROJECT_ID",
  targetLanguageConfigs: [{ language: "fr" }],
  selectedMemories: [memory.id],
});

Folders

const folders = await ollang.folders.list({ pageOptions: { page: 1, take: 20 } });
const pairs = await ollang.folders.orderLanguagePairs("FOLDER_ID", "completed");

// Assign a translator to every French order in the folder
await ollang.folders.assignTranslator("FOLDER_ID", {
  translatorId: "TRANSLATOR_ID",
  targetLanguage: "fr",
  deadline: "2026-06-01",
});

Billing

const wallet = await ollang.billing.credits();
const usage = await ollang.billing.consumption({
  pageOptions: { page: 1, take: 20 },
  filter: { from: "2026-01-01", provider: "deepl" },
});

Large remote files

createByUrl hands the platform a URL to fetch server-side, so the bytes never pass through your process and there is no practical size ceiling.

const project = await ollang.projects.createByUrl({
  url: "https://example.com/video.mp4",
  name: "Launch video",
  sourceLanguage: "en",
});

XLSX exports

The export endpoints resolve to a Buffer rather than JSON. Each has a ...ToFile companion that writes the workbook to a path, creating parent directories as needed.

const data = await ollang.orders.exportXlsx("ORDER_ID");

await ollang.orders.exportXlsxToFile("ORDER_ID", "out/order.xlsx");
await ollang.folders.exportXlsxToFile(
  { folderIds: ["FOLDER_ID"], targetLanguages: ["fr", "de"] },
  "out/folders.xlsx"
);

The underlying HTTP client stays available for anything not wrapped yet: ollang.getClient().get("/integration/orders"). See the full API reference for every endpoint.

Ollang SDK

Client Libraries

Node.js Library

Node.js Library

Installation

Authentication

Quick Start

Naming the uploaded file

Uploading VTT subtitles

Resources

More Examples

Resolve a language code

Translation memories

Folders

Billing

Large remote files

XLSX exports

​Node.js Library

​Installation

​Authentication

​Quick Start

​Naming the uploaded file

​Uploading VTT subtitles

​Resources

​More Examples

​Resolve a language code

​Translation memories

​Folders

​Billing

​Large remote files

​XLSX exports

Node.js Library

Installation

Authentication

Quick Start

Naming the uploaded file

Uploading VTT subtitles

Resources

More Examples

Resolve a language code

Translation memories

Folders

Billing

Large remote files

XLSX exports