Skip to main content

Documentation Index

Fetch the complete documentation index at: https://api-docs.ollang.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Use Cases

End-to-end walkthroughs of common Ollang localization workflows. Each section shows the recommended integration surface (REST, MCP, SDK, or Skills), the order types involved, and where human review or QC fits. All examples use generic placeholders — replace <your-api-key>, <project-id>, and <order-id> with values from your account.

​
At a Glance

Use caseOrder typesIntegration surface
Marketing video, multi-language AI dubbingaiDubbingREST API, MCP, Skills
Enterprise subtitle pipeline with human reviewcc → subtitle (Level 1)REST API, MCP
Document localization (legal, marketing, technical)documentREST API, MCP, Skills
Visual / image-to-image translationdocument (JPEG/PNG via Direct Upload)REST API, MCP
Studio dubbing coordinationstudioDubbingREST API + Dashboard
Accessibility / Audio DescriptionaiDubbing with dubbingStyle: audioDescriptionREST API, MCP
Continuous localization for an app’s i18n stringsdocument on extracted stringsSDK Asset Management
Website / CMS content localizationdocument per resourceSDK Browser SDK + MCP

​
1. Marketing Video — Multi-Language AI Dubbing

Goal: Take a 60–120 second product or marketing video in English and deliver dubbed audio plus a mixed video master in 5–10 target languages, overnight, with no studio booking. Recommended surface: REST API or MCP. Workflow: 
Upload MP4 (Direct Upload)
        ↓
Create one aiDubbing order per target language
        ↓
(Optional) Auto QC after generation
        ↓
Download mixed video + dubbing audio per language
        ↓
(Optional) Upgrade specific languages to Level 1
REST example: 
# 1. Upload source video
curl -X POST "https://api-integration.ollang.com/integration/upload/direct" \
  -H "X-Api-Key: <your-api-key>" \
  -F "file=@./launch_video.mp4" \
  -F "name=launch_video" \
  -F "sourceLanguage=en"
# → { "projectId": "<project-id>" }

# 2. Create AI Dubbing orders for FR, DE, JA, ES
curl -X POST "https://api-integration.ollang.com/integration/orders/create" \
  -H "X-Api-Key: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "orderType": "aiDubbing",
    "level": 0,
    "dubbingStyle": "overdub",
    "projectId": "<project-id>",
    "targetLanguageConfigs": [
      { "language": "fr" },
      { "language": "de" },
      { "language": "ja" },
      { "language": "es" }
    ],
    "callbackUrl": "https://example.com/webhooks/ollang",
    "autoQc": true
  }'
# → [ {orderId}, {orderId}, {orderId}, {orderId} ]
What gets delivered: A mixed master video, dubbing audio, vocals-only track, and a Created M&E file per language. See Order Types and Workflow Architecture. When to upgrade to Level 1: Use AI-only (Level 0) for previews and internal review. Promote the languages destined for paid distribution to Level 1 via Request Human Review.

​
2. Enterprise Subtitle Pipeline with Human Review

Goal: A localization team ships dozens of training or product videos per week. Each video needs accurate, brand-consistent subtitles in 4–8 languages, reviewed by a linguist before release. Recommended surface: REST API, with workflow rules configured in the Olabs Dashboard. Workflow: 
Upload source video into a Folder
        ↓
Create cc (Closed Captions) order if no source subtitle exists
        ↓
Create subtitle orders at Level 1 (Human Review)
        ↓
Linguists edit inside the Editor Interface
        ↓
Deliver → export SRT / VTT / DOCX (and more)
        ↓
Folder-scoped Memory + Custom Instructions improve future orders
Why a Folder? Configure folder-level Workflows (which providers to use), Custom Instructions (tone, terminology), and Review Gates (which orders are auto-routed to linguists). Folder workflows override Global workflows — see Workflows and Provider Architecture. Tips:
  • Attach a glossary as a supporting asset on the project — the linguist will see it in the Editor Interface. See Source Files and Asset Handling.
  • Enable autoQc on the create order request so each order has a QC score before review starts. See Run QC Evaluation.
  • Reuse the same project for multiple subtitle and dubbing orders to share supporting assets across deliverables.
Goal: Localize contracts, marketing collateral, or product documentation into multiple languages. Preserve formatting, keep terminology consistent, and roll back to a previous version if needed. Recommended surface: REST API, MCP (for ad-hoc), or SDK (for repeated batches). Supported formats: DOCX, PDF, PPTX, XLSX, HTML, JSON, XLIFF, SDLXLIFF, PO, TXT, SRT, VTT, Pages, Keynote, Numbers. See Source Files and Asset Handling. REST example: 
# 1. Upload DOCX
curl -X POST "https://api-integration.ollang.com/integration/upload/direct" \
  -H "X-Api-Key: <your-api-key>" \
  -F "file=@./contract.docx" \
  -F "name=contract" \
  -F "sourceLanguage=en" \
  -F "folderId=<folder-id>"

# 2. Create document translation orders for ES, DE
curl -X POST "https://api-integration.ollang.com/integration/orders/create" \
  -H "X-Api-Key: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "orderType": "document",
    "level": 1,
    "projectId": "<project-id>",
    "targetLanguageConfigs": [
      { "language": "es" },
      { "language": "de" }
    ]
  }'
Tips:
  • Attach Folder-level Guidelines (tone, formal/informal register, preserved terms) so every document under that folder picks them up automatically. See Memory, Guidelines, and Custom Instructions.
  • Use Memory to enforce approved translations of recurring product names, legal terms, or trademarks.
  • Reruns retain previous versions — useful for contract amendments. See Rerun Order.

​
4. Visual Translation (Image-to-Image)

Goal: Localize on-screen text inside banners, screenshots, presentation slides, or product visuals while preserving the original layout and design. Recommended surface: REST API or MCP. Important: Visual Translation runs through the document order type when the source is a JPEG, JPG, or PNG uploaded via Direct File Upload. There is no separate visualTranslation orderType enum. Workflow: 
# 1. Upload image (JPEG/JPG/PNG)
curl -X POST "https://api-integration.ollang.com/integration/upload/direct" \
  -H "X-Api-Key: <your-api-key>" \
  -F "file=@./banner.png" \
  -F "name=summer_sale_banner" \
  -F "sourceLanguage=en"

# 2. Create document order for FR, IT
curl -X POST "https://api-integration.ollang.com/integration/orders/create" \
  -H "X-Api-Key: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "orderType": "document",
    "level": 0,
    "projectId": "<project-id>",
    "targetLanguageConfigs": [{ "language": "fr" }, { "language": "it" }]
  }'
Other Visual Translation inputs: Adobe After Effects project files and video-embedded visual text. See Visual Translation in the user guides for the full input matrix.

​
5. Studio Dubbing Coordination

Goal: Coordinate a multi-language dubbing campaign with external studios — Ollang manages the workflow, studios deliver vocals and final mixes. Recommended surface: Dashboard for setup + REST API for automation. Workflow: 
Upload video + dubbing script
        ↓
Create studioDubbing orders per language
        ↓
Studios receive assignment, record dubbed vocals
        ↓
Studios upload vocals / final mix / Mixmaster
        ↓
Ollang generates final delivery
        ↓
Download mixed masters
Notes:

​
6. Accessibility — Audio Description

Goal: Add narration describing on-screen visuals for accessibility compliance. Recommended surface: REST API or MCP. Rules:
  • Source language and target language are the same (e.g. English video with English Audio Description).
  • Use orderType: aiDubbing with dubbingStyle: audioDescription.
REST example: 
curl -X POST "https://api-integration.ollang.com/integration/orders/create" \
  -H "X-Api-Key: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "orderType": "aiDubbing",
    "dubbingStyle": "audioDescription",
    "level": 0,
    "projectId": "<project-id>",
    "targetLanguageConfigs": [{ "language": "en" }]
  }'
Deliverables: AD Mixed Audio (2.0 and 5.1), AD Narrator Audio (2.0 and 5.1), AD Mixed Video, Created M&E, and Source Vocals-Only Audio. See Audio Description Deliverables.

​
7. Continuous Localization for App i18n Strings

Goal: Translate messages/*.json (or other i18n string files) as new keys are added during development, and apply translations back to the codebase automatically. Recommended surface: Ollang SDK Asset Management. Workflow: 
ollang.config.ts defines source/target languages
        ↓
npx @ollang-dev/sdk start
        ↓
Scan project → Kanban board shows new/changed strings
        ↓
Select strings → submit for translation
        ↓
SDK creates document orders behind the scenes
        ↓
Translated values applied back to your JSON files
Config example:
ollang.config.ts
export default {
  projectRoot: ".",
  sourceLanguage: "en",
  targetLanguages: ["fr", "de", "ja", "es"],
};
Why the SDK: It handles file scanning, diffing, mapping translations back to the right JSON paths, and tracking which strings were sent for translation in a local kanban. See SDK Features. CI integration: Run the SDK in headless mode against your i18n folder as part of a release pipeline; gate releases on translation completion via the REST API.

​
8. Website / CMS Content Localization

Goal: Localize content authored in a CMS (Strapi, custom headless) or content that lives on a live web page. Recommended surfaces:
  • SDK Browser SDK for in-browser CMS capture.
  • MCP for ad-hoc localization through an AI assistant.
Browser SDK flow:
  1. Add the Ollang Browser script to your CMS-powered site.
  2. Visit the site with ?ollang-localize=true.
  3. Capture content via the debug panel as you navigate.
  4. Submit captured content from the Asset Management control panel.
See SDK Quickstart — Browser CMS Capture. MCP flow: Configure the Ollang MCP server in your AI client, then ask: “Localize the homepage hero copy from the Strapi CMS into French and Italian.” The assistant calls uploadFile and createOrder on your behalf.

​
9. AI Agent–Driven Localization (Skills + MCP)

Goal: Let an AI coding agent (Cursor, Claude Code, Codex, Windsurf, Devin) trigger translations and check status from a single conversation — no dashboard switching, no custom prompts. Recommended surfaces:
  • Skills — file-based, no server. Best for editor-bound dev workflows.
  • MCP — hosted, OAuth-authenticated. Best when multiple humans / agents share the same Ollang account.
Example agent prompt: 
Upload the video at https://example.com/demo.mp4 to Ollang as English,
then create AI dubbing orders for French and Japanese with overdub style
and auto QC. Report the order IDs and check status in 60 seconds.
The agent calls uploadFile, then createOrder, then getOrderById — all via the same underlying REST endpoints. See Skills Sub-Skills Reference and MCP Tools Reference for the full tool list.

​
Choosing the Right Pattern

One-off / exploratory

REST API with curl, or natural language via Skills/MCP. Skip callbacks; poll Get Order by ID.

Production pipeline

REST API or SDK, with callbackUrl for completion events. Idempotent callback handler. Folder-scoped workflows. See Best Practices.

Team / non-developer users

MCP from Claude Desktop / Cursor / Devin. OAuth handles auth; users work in natural language.

Continuous in-codebase localization

SDK Asset Management. Kanban board for visibility. Sync back to JSON.

​
See Also