Upload TM

Upload your Translation Memory for Crowdin Project in TMX, CSV or XLS/XLSX file format.

Request

Note: Either use the combination of project identifier and project key or combination of project identifier, username, and account key to pass to this endpoint.

POST https://api.crowdin.com/api/project/{project-identifier}/upload-tm?key={project-key}
POST https://api.crowdin.com/api/project/{project-identifier}/upload-tm?login={username}&account-key={account-key}

Parameters

Name Value Description
file required file File in TMX, CSV or XLS/XLSX formats. See TMX 1.4b Specification.
first_line_contains_header CSV and XLS/XLSX files only
optional		 string Used when uploading CSV (or XLS/XLSX) files via API. Defines whether first line should be imported or it contains columns headers. May not contain value.
scheme CSV and XLS/XLSX files only
required		 string Note: Used only when uploading CSV (or XLS/XLSX) file to define data columns mapping.
Acceptable value is the combination of the following constants (%language_code% is a placeholder for your language code): Example parameter you will have to add: &scheme=phrase_en,none,phrase_uk,phrase_fr
json optional string May not contain value. Defines that response should be in JSON format.
jsonp optional string Callback function name. Defines that response should be in JSONP format.
Variables
project-identifier string Project identifier.
project-key string Project API key. Either the project-key or combination of username and account-key are required.
username string Your username in Crowdin. Either the project-key or combination of username and account-key are required.
account-key string Your account API key. Either the project-key or combination of username and account-key are required.

Response

If successful, this method returns a XML structure, as it is shown below. 
<?xml version="1.0" encoding="ISO-8859-1"?>
<success>
</success>
Unsuccessful response sample: 
<?xml version="1.0" encoding="ISO-8859-1"?>
<error>
  <code>3</code>
  <message>API key is not valid</message>
</error>

Examples

curl \
  -F "file=@translation-memory.tmx" \
  https://api.crowdin.com/api/project/{project-identifier}/upload-tm?key={project-key}
curl \
  -F "file=@tm.csv" \
  -F "first_line_contains_header=true" \
  -F "scheme=phrase_en,none,phrase_uk,phrase_fr" \
  https://api.crowdin.com/api/project/{project-identifier}/upload-tm?key={project-key}
<?php
$post_params = array();
$request_url = 'https://api.crowdin.com/api/project/{project-identifier}/upload-tm?key={project-key}';

if(function_exists('curl_file_create')) {
  $post_params['file'] = curl_file_create('/home/crowdin/test.tmx');
} else {
  $post_params['file'] = '@/home/crowdin/test.tmx';
}

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $request_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post_params);

$result = curl_exec($ch);
curl_close($ch);

echo $result;

Was this article helpful?