curl -X GET "https://api-integration.ollang.com/integration/project/60b8d6f1e1b9b1d8c6c0d8e1" \
-H "X-Api-Key: <your-api-key>"
const projectId = "60b8d6f1e1b9b1d8c6c0d8e1";
const response = await fetch(
`https://api-integration.ollang.com/integration/project/${projectId}`,
{
method: "GET",
headers: {
"X-Api-Key": "<your-api-key>",
},
}
);
const project = await response.json();
console.log("Project details:", project);
import requests
project_id = "60b8d6f1e1b9b1d8c6c0d8e1"
headers = {
'X-Api-Key': '<your-api-key>'
}
response = requests.get(
f'https://api-integration.ollang.com/integration/project/{project_id}',
headers=headers
)
project = response.json()
print("Project details:", project)
$projectId = '60b8d6f1e1b9b1d8c6c0d8e1';
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api-integration.ollang.com/integration/project/' . $projectId,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => array(
'X-Api-Key: <your-api-key>'
),
));
$response = curl_exec($curl);
$project = json_decode($response, true);
curl_close($curl);
echo "Project details: " . json_encode($project);
package main
import (
"encoding/json"
"fmt"
"io"
"net/http"
)
func main() {
projectId := "60b8d6f1e1b9b1d8c6c0d8e1"
url := fmt.Sprintf("https://api-integration.ollang.com/integration/project/%s", projectId)
req, _ := http.NewRequest("GET", url, nil)
req.Header.Set("X-Api-Key", "<your-api-key>")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
var project map[string]interface{}
json.Unmarshal(body, &project)
fmt.Println("Project details:", project)
}
String projectId = "60b8d6f1e1b9b1d8c6c0d8e1";
String url = "https://api-integration.ollang.com/integration/project/" + projectId;
HttpResponse<String> response = Unirest.get(url)
.header("X-Api-Key", "<your-api-key>")
.asString();
JSONObject project = new JSONObject(response.getBody());
System.out.println("Project details: " + project.toString());
{
"id": "60b8d6f1e1b9b1d8c6c0d8e1",
"name": "Marketing Video Q4",
"sourceLanguage": "en",
"createdAt": "2024-01-15T10:30:45.511Z",
"folderId": "60b8d6f1e1b9b1d8c6c0d8e2",
"projectDocs": [
{
"id": "60b8d6f1e1b9b1d8c6c0d8e3",
"createdAt": "2024-01-15T10:30:45.511Z",
"updatedAt": "2024-01-15T10:35:22.847Z",
"name": "marketing_video_q4.mp4",
"url": "https://storage.ollang.com/files/marketing_video_q4.mp4",
"type": "source_video",
"size": 157286400,
"duration": 240,
"sourceLanguage": "en",
"clientId": "60b8d6f1e1b9b1d8c6c0d8e4",
"projectId": "60b8d6f1e1b9b1d8c6c0d8e1",
"folderId": "60b8d6f1e1b9b1d8c6c0d8e2",
"thumbnailUrl": "https://storage.ollang.com/thumbnails/marketing_video_q4.jpg"
},
{
"id": "60b8d6f1e1b9b1d8c6c0d8e5",
"createdAt": "2024-01-15T10:32:18.211Z",
"updatedAt": "2024-01-15T10:32:18.211Z",
"name": "marketing_video_waveform.png",
"url": "https://storage.ollang.com/waveforms/marketing_video_waveform.png",
"type": "created_waveform",
"size": 524288,
"clientId": "60b8d6f1e1b9b1d8c6c0d8e4",
"projectId": "60b8d6f1e1b9b1d8c6c0d8e1",
"folderId": "60b8d6f1e1b9b1d8c6c0d8e2"
}
],
"ordersCount": 3
}
{
"error": "Project not found",
"message": "No project found with the provided projectId",
"code": "PROJECT_NOT_FOUND"
}
{
"error": "Access denied",
"message": "You don't have permission to access this project",
"code": "ACCESS_DENIED"
}
{
"error": "Unauthorized",
"message": "Invalid or missing API key",
"code": "UNAUTHORIZED"
}
{
"error": "Invalid project ID",
"message": "The provided projectId is not a valid MongoDB ObjectId",
"code": "INVALID_PROJECT_ID"
}
Ollang API Reference
Get Project By ID
Retrieve detailed information about a specific project using its unique identifier
GET
/
integration
/
project
/
{projectId}
curl -X GET "https://api-integration.ollang.com/integration/project/60b8d6f1e1b9b1d8c6c0d8e1" \
-H "X-Api-Key: <your-api-key>"
const projectId = "60b8d6f1e1b9b1d8c6c0d8e1";
const response = await fetch(
`https://api-integration.ollang.com/integration/project/${projectId}`,
{
method: "GET",
headers: {
"X-Api-Key": "<your-api-key>",
},
}
);
const project = await response.json();
console.log("Project details:", project);
import requests
project_id = "60b8d6f1e1b9b1d8c6c0d8e1"
headers = {
'X-Api-Key': '<your-api-key>'
}
response = requests.get(
f'https://api-integration.ollang.com/integration/project/{project_id}',
headers=headers
)
project = response.json()
print("Project details:", project)
$projectId = '60b8d6f1e1b9b1d8c6c0d8e1';
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api-integration.ollang.com/integration/project/' . $projectId,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => array(
'X-Api-Key: <your-api-key>'
),
));
$response = curl_exec($curl);
$project = json_decode($response, true);
curl_close($curl);
echo "Project details: " . json_encode($project);
package main
import (
"encoding/json"
"fmt"
"io"
"net/http"
)
func main() {
projectId := "60b8d6f1e1b9b1d8c6c0d8e1"
url := fmt.Sprintf("https://api-integration.ollang.com/integration/project/%s", projectId)
req, _ := http.NewRequest("GET", url, nil)
req.Header.Set("X-Api-Key", "<your-api-key>")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
var project map[string]interface{}
json.Unmarshal(body, &project)
fmt.Println("Project details:", project)
}
String projectId = "60b8d6f1e1b9b1d8c6c0d8e1";
String url = "https://api-integration.ollang.com/integration/project/" + projectId;
HttpResponse<String> response = Unirest.get(url)
.header("X-Api-Key", "<your-api-key>")
.asString();
JSONObject project = new JSONObject(response.getBody());
System.out.println("Project details: " + project.toString());
{
"id": "60b8d6f1e1b9b1d8c6c0d8e1",
"name": "Marketing Video Q4",
"sourceLanguage": "en",
"createdAt": "2024-01-15T10:30:45.511Z",
"folderId": "60b8d6f1e1b9b1d8c6c0d8e2",
"projectDocs": [
{
"id": "60b8d6f1e1b9b1d8c6c0d8e3",
"createdAt": "2024-01-15T10:30:45.511Z",
"updatedAt": "2024-01-15T10:35:22.847Z",
"name": "marketing_video_q4.mp4",
"url": "https://storage.ollang.com/files/marketing_video_q4.mp4",
"type": "source_video",
"size": 157286400,
"duration": 240,
"sourceLanguage": "en",
"clientId": "60b8d6f1e1b9b1d8c6c0d8e4",
"projectId": "60b8d6f1e1b9b1d8c6c0d8e1",
"folderId": "60b8d6f1e1b9b1d8c6c0d8e2",
"thumbnailUrl": "https://storage.ollang.com/thumbnails/marketing_video_q4.jpg"
},
{
"id": "60b8d6f1e1b9b1d8c6c0d8e5",
"createdAt": "2024-01-15T10:32:18.211Z",
"updatedAt": "2024-01-15T10:32:18.211Z",
"name": "marketing_video_waveform.png",
"url": "https://storage.ollang.com/waveforms/marketing_video_waveform.png",
"type": "created_waveform",
"size": 524288,
"clientId": "60b8d6f1e1b9b1d8c6c0d8e4",
"projectId": "60b8d6f1e1b9b1d8c6c0d8e1",
"folderId": "60b8d6f1e1b9b1d8c6c0d8e2"
}
],
"ordersCount": 3
}
{
"error": "Project not found",
"message": "No project found with the provided projectId",
"code": "PROJECT_NOT_FOUND"
}
{
"error": "Access denied",
"message": "You don't have permission to access this project",
"code": "ACCESS_DENIED"
}
{
"error": "Unauthorized",
"message": "Invalid or missing API key",
"code": "UNAUTHORIZED"
}
{
"error": "Invalid project ID",
"message": "The provided projectId is not a valid MongoDB ObjectId",
"code": "INVALID_PROJECT_ID"
}
Retrieve comprehensive details about a specific project, including associated documents and metadata. This endpoint provides more detailed information than the projects list endpoint.
curl -X GET "https://api-integration.ollang.com/integration/project/60b8d6f1e1b9b1d8c6c0d8e1" \
-H "X-Api-Key: <your-api-key>"
const projectId = "60b8d6f1e1b9b1d8c6c0d8e1";
const response = await fetch(
`https://api-integration.ollang.com/integration/project/${projectId}`,
{
method: "GET",
headers: {
"X-Api-Key": "<your-api-key>",
},
}
);
const project = await response.json();
console.log("Project details:", project);
import requests
project_id = "60b8d6f1e1b9b1d8c6c0d8e1"
headers = {
'X-Api-Key': '<your-api-key>'
}
response = requests.get(
f'https://api-integration.ollang.com/integration/project/{project_id}',
headers=headers
)
project = response.json()
print("Project details:", project)
$projectId = '60b8d6f1e1b9b1d8c6c0d8e1';
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api-integration.ollang.com/integration/project/' . $projectId,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => array(
'X-Api-Key: <your-api-key>'
),
));
$response = curl_exec($curl);
$project = json_decode($response, true);
curl_close($curl);
echo "Project details: " . json_encode($project);
package main
import (
"encoding/json"
"fmt"
"io"
"net/http"
)
func main() {
projectId := "60b8d6f1e1b9b1d8c6c0d8e1"
url := fmt.Sprintf("https://api-integration.ollang.com/integration/project/%s", projectId)
req, _ := http.NewRequest("GET", url, nil)
req.Header.Set("X-Api-Key", "<your-api-key>")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
var project map[string]interface{}
json.Unmarshal(body, &project)
fmt.Println("Project details:", project)
}
String projectId = "60b8d6f1e1b9b1d8c6c0d8e1";
String url = "https://api-integration.ollang.com/integration/project/" + projectId;
HttpResponse<String> response = Unirest.get(url)
.header("X-Api-Key", "<your-api-key>")
.asString();
JSONObject project = new JSONObject(response.getBody());
System.out.println("Project details: " + project.toString());
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 project to retrieve. This should be a valid
MongoDB ObjectId that you have access to.
Response
The response contains detailed information about the requested project, including all associated documents.string
Unique identifier of the project.
string
Name of the project as provided during upload.
string
Source language of the project using ISO 639-1 language codes (e.g., “en”,
“tr”, “fr”).
string
The date and time when the project was created in ISO 8601 format.
string
Identifier of the folder associated with the project for organization
purposes.
array
Array of documents associated with the project, including source files and generated content.
Show Document Object Properties
Show Document Object Properties
string
Unique identifier of the document.
string
The creation date of the document in ISO 8601 format.
string
The last update date of the document in ISO 8601 format.
string
Name of the document.
string
URL of the document for access or download.
string
Type of the document. See Document Types for available values.
number
Size of the document in bytes.
string
Storage URL of the document if different from the main URL.
number
Word count of the document, applicable to text documents.
number
Duration of the document if it is a media file, in seconds.
string
Source language of the document, typically in ISO 639-1 format.
string
URL of the waveform image if applicable to audio documents.
string
Identifier of the project this document is associated with.
string
Identifier of the order this document is associated with.
string
Identifier of the client who owns the document.
string
URL of the thumbnail image of the document.
string
Identifier of the folder where the document is stored.
number
Number of orders related to this project.
{
"id": "60b8d6f1e1b9b1d8c6c0d8e1",
"name": "Marketing Video Q4",
"sourceLanguage": "en",
"createdAt": "2024-01-15T10:30:45.511Z",
"folderId": "60b8d6f1e1b9b1d8c6c0d8e2",
"projectDocs": [
{
"id": "60b8d6f1e1b9b1d8c6c0d8e3",
"createdAt": "2024-01-15T10:30:45.511Z",
"updatedAt": "2024-01-15T10:35:22.847Z",
"name": "marketing_video_q4.mp4",
"url": "https://storage.ollang.com/files/marketing_video_q4.mp4",
"type": "source_video",
"size": 157286400,
"duration": 240,
"sourceLanguage": "en",
"clientId": "60b8d6f1e1b9b1d8c6c0d8e4",
"projectId": "60b8d6f1e1b9b1d8c6c0d8e1",
"folderId": "60b8d6f1e1b9b1d8c6c0d8e2",
"thumbnailUrl": "https://storage.ollang.com/thumbnails/marketing_video_q4.jpg"
},
{
"id": "60b8d6f1e1b9b1d8c6c0d8e5",
"createdAt": "2024-01-15T10:32:18.211Z",
"updatedAt": "2024-01-15T10:32:18.211Z",
"name": "marketing_video_waveform.png",
"url": "https://storage.ollang.com/waveforms/marketing_video_waveform.png",
"type": "created_waveform",
"size": 524288,
"clientId": "60b8d6f1e1b9b1d8c6c0d8e4",
"projectId": "60b8d6f1e1b9b1d8c6c0d8e1",
"folderId": "60b8d6f1e1b9b1d8c6c0d8e2"
}
],
"ordersCount": 3
}
{
"error": "Project not found",
"message": "No project found with the provided projectId",
"code": "PROJECT_NOT_FOUND"
}
{
"error": "Access denied",
"message": "You don't have permission to access this project",
"code": "ACCESS_DENIED"
}
{
"error": "Unauthorized",
"message": "Invalid or missing API key",
"code": "UNAUTHORIZED"
}
{
"error": "Invalid project ID",
"message": "The provided projectId is not a valid MongoDB ObjectId",
"code": "INVALID_PROJECT_ID"
}
Was this page helpful?
⌘I