curl -X GET "https://api-integration.ollang.com/integration/orders/60b8d6f1e1b9b1d8c6c0d8e1/on-screen-text" \
-H "X-Api-Key: $OLLANG_API_KEY"
const orderId = "60b8d6f1e1b9b1d8c6c0d8e1";
const response = await fetch(
`https://api-integration.ollang.com/integration/orders/${orderId}/on-screen-text`,
{ headers: { "X-Api-Key": process.env.OLLANG_API_KEY } },
);
const { rows } = await response.json();
import os
import requests
order_id = "60b8d6f1e1b9b1d8c6c0d8e1"
response = requests.get(
f"https://api-integration.ollang.com/integration/orders/{order_id}/on-screen-text",
headers={"X-Api-Key": os.environ["OLLANG_API_KEY"]},
)
rows = response.json()["rows"]
{
"orderId": "60b8d6f1e1b9b1d8c6c0d8e1",
"orderName": "My Video",
"orderType": "subtitle",
"targetLanguage": "fr",
"targetLanguageName": "French",
"fileName": "My Video_on-screen-text.xlsx",
"rows": [
{
"index": 1,
"start": "00:00:01,000",
"end": "00:00:03,500",
"original": "SALE 50% OFF",
"translation": "SOLDES -50 %"
}
]
}
{
"statusCode": 400,
"message": "Visual translation is not enabled for this order"
}
{
"statusCode": 404,
"message": "Order does not exist."
}
Content and exports
Get On-Screen Text
Get the on-screen text (visual translation) rows of an order as JSON
GET
/
integration
/
orders
/
{orderId}
/
on-screen-text
curl -X GET "https://api-integration.ollang.com/integration/orders/60b8d6f1e1b9b1d8c6c0d8e1/on-screen-text" \
-H "X-Api-Key: $OLLANG_API_KEY"
const orderId = "60b8d6f1e1b9b1d8c6c0d8e1";
const response = await fetch(
`https://api-integration.ollang.com/integration/orders/${orderId}/on-screen-text`,
{ headers: { "X-Api-Key": process.env.OLLANG_API_KEY } },
);
const { rows } = await response.json();
import os
import requests
order_id = "60b8d6f1e1b9b1d8c6c0d8e1"
response = requests.get(
f"https://api-integration.ollang.com/integration/orders/{order_id}/on-screen-text",
headers={"X-Api-Key": os.environ["OLLANG_API_KEY"]},
)
rows = response.json()["rows"]
{
"orderId": "60b8d6f1e1b9b1d8c6c0d8e1",
"orderName": "My Video",
"orderType": "subtitle",
"targetLanguage": "fr",
"targetLanguageName": "French",
"fileName": "My Video_on-screen-text.xlsx",
"rows": [
{
"index": 1,
"start": "00:00:01,000",
"end": "00:00:03,500",
"original": "SALE 50% OFF",
"translation": "SOLDES -50 %"
}
]
}
{
"statusCode": 400,
"message": "Visual translation is not enabled for this order"
}
{
"statusCode": 404,
"message": "Order does not exist."
}
Returns the on-screen text rows of a CC, Subtitle or AI Dubbing order that has visual translation enabled: the text that appears in the video (signs, titles, captions burned into the picture), with its timecodes and translation. Rows are sorted by start time.
These are the same rows as the dashboard’s On-Screen Text (XLSX) download. To get the spreadsheet itself, use Export On-Screen Text XLSX.
curl -X GET "https://api-integration.ollang.com/integration/orders/60b8d6f1e1b9b1d8c6c0d8e1/on-screen-text" \
-H "X-Api-Key: $OLLANG_API_KEY"
const orderId = "60b8d6f1e1b9b1d8c6c0d8e1";
const response = await fetch(
`https://api-integration.ollang.com/integration/orders/${orderId}/on-screen-text`,
{ headers: { "X-Api-Key": process.env.OLLANG_API_KEY } },
);
const { rows } = await response.json();
import os
import requests
order_id = "60b8d6f1e1b9b1d8c6c0d8e1"
response = requests.get(
f"https://api-integration.ollang.com/integration/orders/{order_id}/on-screen-text",
headers={"X-Api-Key": os.environ["OLLANG_API_KEY"]},
)
rows = response.json()["rows"]
Authorizations
This endpoint requires API key authentication. Include your API key in the request header:- Header name:
X-Api-Key - Header value: Your API key from the Ollang dashboard
Path Parameters
The unique identifier of a CC, Subtitle or AI Dubbing order with visual translation enabled. The order must belong to the API key’s client.
Response
English name of the target language, for example
French. The XLSX export uses it as the sheet name.On-screen text rows, sorted by start time.
{
"orderId": "60b8d6f1e1b9b1d8c6c0d8e1",
"orderName": "My Video",
"orderType": "subtitle",
"targetLanguage": "fr",
"targetLanguageName": "French",
"fileName": "My Video_on-screen-text.xlsx",
"rows": [
{
"index": 1,
"start": "00:00:01,000",
"end": "00:00:03,500",
"original": "SALE 50% OFF",
"translation": "SOLDES -50 %"
}
]
}
{
"statusCode": 400,
"message": "Visual translation is not enabled for this order"
}
{
"statusCode": 404,
"message": "Order does not exist."
}
Errors
An order whose on-screen text hasn’t been extracted yet returns200 with rows: [].
| Status | When |
|---|---|
| 400 | Visual translation is off for the order, or the order type isn’t CC, Subtitle or AI Dubbing. |
| 401 | The API key is missing or invalid. |
| 404 | The order doesn’t exist or belongs to another client. |
Was this page helpful?