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.

​
Glossary

A quick reference for the terminology used across the Ollang platform and these docs. For full context, follow the links into the user guides.

​
Platform Hierarchy

The highest organizational layer in the platform. Folders are workflow-agnostic containers used to group related projects — by campaign, content type, team, or any operational grouping. Workflow overrides, custom instructions, anomaly detection, and review-gate configuration can all be scoped at the folder level. See Platform Architecture and Workflows and Provider Architecture.
Represents a single source asset (video, audio, document, image, or strings file) uploaded into Ollang. A project is created automatically when you call Direct File Upload and is the parent of one or more orders.
The actual localization workflow. An order has an orderType (e.g. subtitle, aiDubbing), a level, a target language, and references the parent project’s source asset. Each target language in a Create Order request creates a separate order with its own orderId.

​
Order Types

Multilingual dubbed audio + mixed video using AI voice synthesis. Supports overdub, lipsync, and audioDescription dubbing styles. TTS-first flows accept a .txt script with no source video. See Order Types and Workflow Architecture.
Translate timed dialogue and subtitle assets. Produces SRT, VTT, ASS, STL, SCC, DFXP, ITT, DOCX, XLSX, and dubbing-script exports. See Deliverables and Export Pipelines.
Generate closed captions or timecoded transcription from source media. Uses the orderSubType field to choose between closedCaption and timecodedTranscription.
Localize DOCX, PDF, PPTX, XLSX, HTML, JSON, DITA, mobile strings (.xml, .strings, .stringsdict), AE projects, and JPEG/PNG image-to-image content. Versions are retained across reruns for rollback.
Coordinate external dubbing studios — Ollang acts as the orchestration and delivery layer for studio-produced vocals, M&E, and mixed outputs. See Teams, Permissions, and LSP Hierarchy.
Localize on-screen text inside videos, graphics, and visual assets. Preserves layout, positioning, and multilingual consistency. Visual Translation is a platform capability, not a separate API enum — image-to-image flows run through orderType: document when the source is JPEG / JPG / PNG uploaded via Direct File Upload. See Visual Translation.
Localize website content, UI strings, and structured localization files across languages. Typically runs through orderType: document on extracted strings (JSON, XLIFF, PO, mobile string formats) — or via SDK Browser SDK for in-page CMS capture. Not a separate API enum.

​
Workflow Concepts

0 = full AI output, no human in the loop. 1 = AI output passed through an Ollang Human Review gate. Set in Create Order. Level 0 orders can be escalated to Level 1 later via Request Human Review.
Applies to AI Dubbing orders. One of overdub, lipsync, or audioDescription. Controls voice synthesis pacing, timing, and downstream deliverables.
A reusable configuration that says, for a given language pair and order type, which AI providers and review gates to use. Workflows can be Global (account-wide default) or scoped to a Folder. Folder workflows override Global workflows. Project-level workflows are not currently supported. See Workflows and Provider Architecture.
A configurable step in a workflow that decides whether an order needs human review — based on, for example, an AI QC threshold (qcThreshold). Review modes are Assignment (auto-assign the order to a Team Tag member) or Comment (route to a tag for review-only).
Re-execute a completed order against the current workflow. Useful when source content changes, the workflow is updated, or you want fresh output from newer AI models. See Rerun Order.
When true, Ollang automatically runs a QC evaluation after the AI order completes. Only applies to top-level orders (child orders are excluded). Requires enableQCThreshold on the client. See Run QC Evaluation.

​
People and Teams

Internal Ollang account users — Owner, Admin, Project Manager, or Team Member — operating inside the Project Management Dashboard. They create orders, manage workflows, and review analytics.
Operates inside the Editor interface. Sees only orders explicitly assigned to them — assignment is at the Order level, not Project level.
An external translation vendor with its own internal hierarchy:
  • LSP Admin — manages localization operations and assigns orders.
  • LSP Project Manager — coordinates assignments and delivery pipelines.
  • LSP Linguist — edits assigned orders.
Inviting an editor auto-promotes through the AI → Linguist → Admin flow. See Teams, Permissions, and LSP Hierarchy.
External vendors with their own internal users. Studio Dubbing vendors can upload dubbing vocals, final mixed outputs, and Mixmaster files.

​
Quality and Memory

Automated subtitle quality scoring across four built-in dimensions — Accuracy, Fluency, Tone, Cultural Fit — plus any custom criteria you define. Triggered manually, automatically (autoQc), or via Run QC Evaluation.
Manual, linguist-driven quality tagging on subtitle segments. Categories include Accuracy, Terminology, Hallucination, Verity; severities are Minor, Major, Critical.
A multilingual reference of approved terminology and translations that Ollang uses to improve consistency on future orders. Organizations can maintain multiple memories (e.g. legal, medical, brand). See Memory, Guidelines, and Custom Instructions.
Account-wide translation guidance applied when no folder or project guideline overrides it. Managed via List / Create / Update / Delete endpoints, or surfaced as Suggestions.
Folder- or project-scoped instructions controlling localization behavior for specific workflows. Take precedence over global Custom Instructions.

​
Assets and Deliverables

The source content being localized — a video, audio file, document, image, or strings file. Uploaded via Direct File Upload.
Anything that helps the linguist or AI — guidelines, glossaries, character lists, reference videos, scripts. See Source Files and Asset Handling.
Background music and environmental audio extracted from the source media, used during dubbing so localized vocals can replace the original dialogue while preserving the surrounding soundscape.
A video output with subtitles burned in. Triggered via API (Request Subtitle Embedding) or from the order page in the dashboard.
A subtitle export optimized for voice actors and dubbing studios. Contains dialogue segmentation, speaker structure, and timing.

​
Platform Capabilities

Use your own LLM provider API keys for Ollang workflows. Plan-gated — check your subscription’s BYOK feature flag. Keys are stored encrypted and applied per-workflow at runtime.
Optional URL provided on Create Order or Rerun Order. Ollang POSTs the completed-order payload to your URL. 10-second timeout, IPv6 blocked at the SSRF guard. Treat handlers as idempotent.
Detects unusual translation patterns (timing drift, unusually long segments, hallucinations) and surfaces them for review. Configurable at folder and project levels with cascade behavior.
Endpoint to download source and deliverable assets for a translator or LSP dashboard in bulk, including Mux video URLs.
Pull and push files between Ollang and external storage. Google Drive supports OAuth and shared drives; subtitle orders push back the burned subtitle video, VTT, and a comments xlsx. Other supported connectors include Dropbox, YouTube, Vimeo, Strapi, and TikTok (private release).