curl -X GET "https://api-integration.ollang.com/integration/orders/60b8d6f1e1b9b1d8c6c0d8e1" \
-H "X-Api-Key: <your-api-key>"
const orderId = "60b8d6f1e1b9b1d8c6c0d8e1";
const response = await fetch(
`https://api-integration.ollang.com/integration/orders/${orderId}`,
{
method: "GET",
headers: {
"X-Api-Key": "<your-api-key>",
},
},
);
const orderData = await response.json();
import requests
order_id = "60b8d6f1e1b9b1d8c6c0d8e1"
headers = {
'X-Api-Key': '<your-api-key>'
}
response = requests.get(
f'https://api-integration.ollang.com/integration/orders/{order_id}',
headers=headers
)
order_data = response.json()
$orderId = '60b8d6f1e1b9b1d8c6c0d8e1';
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api-integration.ollang.com/integration/orders/' . $orderId,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => array(
'X-Api-Key: <your-api-key>'
),
));
$response = curl_exec($curl);
curl_close($curl);
package main
import (
"fmt"
"net/http"
)
func main() {
orderId := "60b8d6f1e1b9b1d8c6c0d8e1"
url := fmt.Sprintf("https://api-integration.ollang.com/integration/orders/%s", orderId)
req, _ := http.NewRequest("GET", url, nil)
req.Header.Set("X-Api-Key", "<your-api-key>")
client := &http.Client{}
resp, _ := client.Do(req)
}
String orderId = "60b8d6f1e1b9b1d8c6c0d8e1";
HttpResponse<String> response = Unirest.get("https://api-integration.ollang.com/integration/orders/" + orderId)
.header("X-Api-Key", "<your-api-key>")
.asString();
{
"id": "60b8d6f1e1b9b1d8c6c0d8e1",
"createdAt": "2024-01-15T10:30:00Z",
"name": "Sample Project - Episode 1",
"sourceLanguage": "en",
"targetLanguage": "fr",
"type": "cc",
"status": "completed",
"rate": 0.15,
"projectId": "proj_xyz789",
"level": 0,
"folderId": "folder_abc123",
"vttUrl": "https://example.com/subtitles/sample_project_fr.vtt",
"orderDocs": [
{
"id": "doc_123abc",
"name": "Sample Project - Source Video",
"url": "https://example.com/videos/sample_project.mp4",
"type": "sourceVideo",
"size": 1073741824,
"duration": 7200,
"sourceLanguage": "en",
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
},
{
"id": "doc_456def",
"name": "French Subtitles",
"url": "https://example.com/subtitles/sample_project_fr.srt",
"type": "subtitle",
"size": 8192,
"wordCount": 1250,
"sourceLanguage": "fr",
"createdAt": "2024-01-16T14:20:00Z",
"updatedAt": "2024-01-16T14:20:00Z"
}
],
"finance": {
"paymentAmount": 150.75
},
"latestEvaluation": {
"id": "eval_abc123def456",
"orderId": "60b8d6f1e1b9b1d8c6c0d8e1",
"createdAt": "2024-01-17T09:00:00Z",
"textSummary": "The translation demonstrates good overall quality with high accuracy and natural fluency. Minor improvements suggested for cultural adaptation.",
"scores": [
{
"name": "Accuracy",
"description": "Translation accuracy and correctness",
"value": 92.5
},
{
"name": "Fluency",
"description": "Natural flow and readability in target language",
"value": 88.0
},
{
"name": "Tone",
"description": "Consistency with original tone and style",
"value": 90.0
},
{
"name": "Cultural Fit",
"description": "Cultural appropriateness for target audience",
"value": 85.5
}
],
"segmentEvals": [
{
"id": "seg_001",
"explain": "Minor grammatical adjustment recommended",
"suggestedNewValue": "Improved translation text here"
}
],
"isLoading": false
}
}
{
"error": "Order not found",
"message": "No order found with the provided orderId",
"code": "ORDER_NOT_FOUND"
}
{
"error": "Access denied",
"message": "You don't have permission to access this order",
"code": "ACCESS_DENIED"
}
{
"error": "Unauthorized",
"message": "Invalid or missing API key",
"code": "UNAUTHORIZED"
}
Ollang API Reference
Get Order by ID
Retrieve detailed information about a specific translation order by its unique identifier
GET
/
integration
/
orders
/
{orderId}
curl -X GET "https://api-integration.ollang.com/integration/orders/60b8d6f1e1b9b1d8c6c0d8e1" \
-H "X-Api-Key: <your-api-key>"
const orderId = "60b8d6f1e1b9b1d8c6c0d8e1";
const response = await fetch(
`https://api-integration.ollang.com/integration/orders/${orderId}`,
{
method: "GET",
headers: {
"X-Api-Key": "<your-api-key>",
},
},
);
const orderData = await response.json();
import requests
order_id = "60b8d6f1e1b9b1d8c6c0d8e1"
headers = {
'X-Api-Key': '<your-api-key>'
}
response = requests.get(
f'https://api-integration.ollang.com/integration/orders/{order_id}',
headers=headers
)
order_data = response.json()
$orderId = '60b8d6f1e1b9b1d8c6c0d8e1';
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api-integration.ollang.com/integration/orders/' . $orderId,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => array(
'X-Api-Key: <your-api-key>'
),
));
$response = curl_exec($curl);
curl_close($curl);
package main
import (
"fmt"
"net/http"
)
func main() {
orderId := "60b8d6f1e1b9b1d8c6c0d8e1"
url := fmt.Sprintf("https://api-integration.ollang.com/integration/orders/%s", orderId)
req, _ := http.NewRequest("GET", url, nil)
req.Header.Set("X-Api-Key", "<your-api-key>")
client := &http.Client{}
resp, _ := client.Do(req)
}
String orderId = "60b8d6f1e1b9b1d8c6c0d8e1";
HttpResponse<String> response = Unirest.get("https://api-integration.ollang.com/integration/orders/" + orderId)
.header("X-Api-Key", "<your-api-key>")
.asString();
{
"id": "60b8d6f1e1b9b1d8c6c0d8e1",
"createdAt": "2024-01-15T10:30:00Z",
"name": "Sample Project - Episode 1",
"sourceLanguage": "en",
"targetLanguage": "fr",
"type": "cc",
"status": "completed",
"rate": 0.15,
"projectId": "proj_xyz789",
"level": 0,
"folderId": "folder_abc123",
"vttUrl": "https://example.com/subtitles/sample_project_fr.vtt",
"orderDocs": [
{
"id": "doc_123abc",
"name": "Sample Project - Source Video",
"url": "https://example.com/videos/sample_project.mp4",
"type": "sourceVideo",
"size": 1073741824,
"duration": 7200,
"sourceLanguage": "en",
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
},
{
"id": "doc_456def",
"name": "French Subtitles",
"url": "https://example.com/subtitles/sample_project_fr.srt",
"type": "subtitle",
"size": 8192,
"wordCount": 1250,
"sourceLanguage": "fr",
"createdAt": "2024-01-16T14:20:00Z",
"updatedAt": "2024-01-16T14:20:00Z"
}
],
"finance": {
"paymentAmount": 150.75
},
"latestEvaluation": {
"id": "eval_abc123def456",
"orderId": "60b8d6f1e1b9b1d8c6c0d8e1",
"createdAt": "2024-01-17T09:00:00Z",
"textSummary": "The translation demonstrates good overall quality with high accuracy and natural fluency. Minor improvements suggested for cultural adaptation.",
"scores": [
{
"name": "Accuracy",
"description": "Translation accuracy and correctness",
"value": 92.5
},
{
"name": "Fluency",
"description": "Natural flow and readability in target language",
"value": 88.0
},
{
"name": "Tone",
"description": "Consistency with original tone and style",
"value": 90.0
},
{
"name": "Cultural Fit",
"description": "Cultural appropriateness for target audience",
"value": 85.5
}
],
"segmentEvals": [
{
"id": "seg_001",
"explain": "Minor grammatical adjustment recommended",
"suggestedNewValue": "Improved translation text here"
}
],
"isLoading": false
}
}
{
"error": "Order not found",
"message": "No order found with the provided orderId",
"code": "ORDER_NOT_FOUND"
}
{
"error": "Access denied",
"message": "You don't have permission to access this order",
"code": "ACCESS_DENIED"
}
{
"error": "Unauthorized",
"message": "Invalid or missing API key",
"code": "UNAUTHORIZED"
}
Retrieve detailed information about a specific translation order using its unique identifier. This endpoint provides comprehensive order details including status, documents, and financial information.
curl -X GET "https://api-integration.ollang.com/integration/orders/60b8d6f1e1b9b1d8c6c0d8e1" \
-H "X-Api-Key: <your-api-key>"
const orderId = "60b8d6f1e1b9b1d8c6c0d8e1";
const response = await fetch(
`https://api-integration.ollang.com/integration/orders/${orderId}`,
{
method: "GET",
headers: {
"X-Api-Key": "<your-api-key>",
},
},
);
const orderData = await response.json();
import requests
order_id = "60b8d6f1e1b9b1d8c6c0d8e1"
headers = {
'X-Api-Key': '<your-api-key>'
}
response = requests.get(
f'https://api-integration.ollang.com/integration/orders/{order_id}',
headers=headers
)
order_data = response.json()
$orderId = '60b8d6f1e1b9b1d8c6c0d8e1';
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api-integration.ollang.com/integration/orders/' . $orderId,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => array(
'X-Api-Key: <your-api-key>'
),
));
$response = curl_exec($curl);
curl_close($curl);
package main
import (
"fmt"
"net/http"
)
func main() {
orderId := "60b8d6f1e1b9b1d8c6c0d8e1"
url := fmt.Sprintf("https://api-integration.ollang.com/integration/orders/%s", orderId)
req, _ := http.NewRequest("GET", url, nil)
req.Header.Set("X-Api-Key", "<your-api-key>")
client := &http.Client{}
resp, _ := client.Do(req)
}
String orderId = "60b8d6f1e1b9b1d8c6c0d8e1";
HttpResponse<String> response = Unirest.get("https://api-integration.ollang.com/integration/orders/" + orderId)
.header("X-Api-Key", "<your-api-key>")
.asString();
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
- Format:
X-Api-Key: your-api-key-here
Path Parameters
string
required
The unique identifier of the order you want to retrieve. This should be a
valid order ID that you have access to.
Response
string
Unique identifier of the order.
string
Creation date and time of the order (ISO 8601 format).
string
Name or title of the order.
string
Source language of the content. Uses ISO 639-1 language codes (e.g., ‘en’,
‘tr’, ‘fr’).
string
Target language for translation. Uses ISO 639-1 language codes (e.g., ‘en’,
‘tr’, ‘fr’).
string
Type of the order. Creatable values are
cc, subtitle, document,
aiDubbing, and studioDubbing — see
Order Types. The platform may
additionally return legacy or system-generated values such as
proofreading, other, or revision on orders that were not created
through Create Order.string
Current status of the order. Possible values:
pending, ongoing,
completed, revision, delayed, waitingForCC, waitingForSubtitle,
delivered, qualityCheck, readyToSent.number
Rate applied to the order for pricing calculation.
string
Associated project identifier that this order belongs to.
number
Service level for the order. Level 0 means full AI generated and Level 1 is
Human Review added version.
string
Folder identifier where the order files are organized and stored.
string
URL to download the VTT subtitle file associated with the order (if
available).
array
Array of documents associated with the order.
Show Document Object Properties
Show Document Object Properties
string
Unique identifier of the document.
string
Name of the document.
string
URL to access or download the document.
string
Type of the document (e.g., sourceVideo, subtitle, translation).
number
Size of the document in bytes.
number
Duration in seconds (for audio/video files).
number
Word count (for text documents).
string
Source language of the document content.
string
Document creation date (ISO 8601 format).
string
Document last update date (ISO 8601 format).
object
Financial details related to the order.
Show Finance Object Properties
Show Finance Object Properties
number
Total amount to be paid for this order.
object
Quality check evaluation for this order, if available. This field is present when a QC evaluation has been run on the order.
Show QC Evaluation Object Properties
Show QC Evaluation Object Properties
string
Unique identifier of the evaluation.
string
Order ID this evaluation belongs to.
string
Creation timestamp of the evaluation (ISO 8601 format).
string
Text summary of the evaluation results.
array
array
boolean
Whether the evaluation is still being processed.
{
"id": "60b8d6f1e1b9b1d8c6c0d8e1",
"createdAt": "2024-01-15T10:30:00Z",
"name": "Sample Project - Episode 1",
"sourceLanguage": "en",
"targetLanguage": "fr",
"type": "cc",
"status": "completed",
"rate": 0.15,
"projectId": "proj_xyz789",
"level": 0,
"folderId": "folder_abc123",
"vttUrl": "https://example.com/subtitles/sample_project_fr.vtt",
"orderDocs": [
{
"id": "doc_123abc",
"name": "Sample Project - Source Video",
"url": "https://example.com/videos/sample_project.mp4",
"type": "sourceVideo",
"size": 1073741824,
"duration": 7200,
"sourceLanguage": "en",
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
},
{
"id": "doc_456def",
"name": "French Subtitles",
"url": "https://example.com/subtitles/sample_project_fr.srt",
"type": "subtitle",
"size": 8192,
"wordCount": 1250,
"sourceLanguage": "fr",
"createdAt": "2024-01-16T14:20:00Z",
"updatedAt": "2024-01-16T14:20:00Z"
}
],
"finance": {
"paymentAmount": 150.75
},
"latestEvaluation": {
"id": "eval_abc123def456",
"orderId": "60b8d6f1e1b9b1d8c6c0d8e1",
"createdAt": "2024-01-17T09:00:00Z",
"textSummary": "The translation demonstrates good overall quality with high accuracy and natural fluency. Minor improvements suggested for cultural adaptation.",
"scores": [
{
"name": "Accuracy",
"description": "Translation accuracy and correctness",
"value": 92.5
},
{
"name": "Fluency",
"description": "Natural flow and readability in target language",
"value": 88.0
},
{
"name": "Tone",
"description": "Consistency with original tone and style",
"value": 90.0
},
{
"name": "Cultural Fit",
"description": "Cultural appropriateness for target audience",
"value": 85.5
}
],
"segmentEvals": [
{
"id": "seg_001",
"explain": "Minor grammatical adjustment recommended",
"suggestedNewValue": "Improved translation text here"
}
],
"isLoading": false
}
}
{
"error": "Order not found",
"message": "No order found with the provided orderId",
"code": "ORDER_NOT_FOUND"
}
{
"error": "Access denied",
"message": "You don't have permission to access this order",
"code": "ACCESS_DENIED"
}
{
"error": "Unauthorized",
"message": "Invalid or missing API key",
"code": "UNAUTHORIZED"
}
Was this page helpful?
⌘I