Suggest Edits

Getting Started

 

The Qordoba API provides secure programmatic access to everything on our web platform using industry standard JSON for input and output of richly structured data. Organized around REST, our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients.

The http://developers.account.qordoba.com/ application control panel lets you generate a consumerKey. This is useful if:

  • Your application only needs to make requests on behalf of a single user (for example, establishing a connection to the SmartSuggest API).
  • You wish to test API functionality from a single account before worrying about the OAuth flow.
Suggest Edits

ping

Returns the status of the Qordoba API.

 
gethttps://api.qordoba.com/v2/ping
curl -i -X GET \
   -H "consumerKey:--consumer_key--" \
 'https://api.qordoba.com/v2/ping'
require 'net/http'
require 'uri'

uri = URI.parse("https://api.qordoba.com/v2/ping")
request = Net::HTTP::Get.new(uri)
request["Consumerkey"] = "--consumer_key--"

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

# response.code
# response.body
import requests

headers = {
    'consumerKey': '--consumer_key--',
}

requests.get('https://api.qordoba.com/v2/ping', headers=headers)
var request = require('request');

var headers = {
    'consumerKey': '--consumer_key--'
};

var options = {
    url: 'https://api.qordoba.com/v2/ping',
    headers: headers
};

function callback(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
}

request(options, callback);
<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'consumerKey' => '--consumer_key--'
);
$response = Requests::get('https://api.qordoba.com/v2/ping', $headers);
A binary file was returned

You couldn't be authenticated

{
  "Status": "Ok"
}
{
  "fault": {
    "faultstring": "Invalid ApiKey for given resource",
    "detail": {
      "errorcode": "oauth.v2.InvalidApiKeyForGivenResource"
    }
  }
}

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

 
Suggest Edits

list countries

Returns the country detail list.

 
gethttps://api.qordoba.com/v2/countries
curl -i -X GET \
   -H "Accept:application/json" \
   -H "consumerKey:--consumer_key--" \
 'https://api.qordoba.com/v2/countries'
require 'net/http'
require 'uri'

uri = URI.parse("https://api.qordoba.com/v2/countries")
request = Net::HTTP::Get.new(uri)
request["Accept"] = "application/json"
request["Consumerkey"] = "--consumer-key--"

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

# response.code
# response.body
import requests

headers = {
    'Accept': 'application/json',
    'consumerKey': '--consumer-key--',
}

requests.get('https://api.qordoba.com/v2/countries', headers=headers)
<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'Accept' => 'application/json',
    'consumerKey' => '--consumer-key--'
);
$response = Requests::get('https://api.qordoba.com/v2/countries', $headers);
var request = require('request');

var headers = {
    'Accept': 'application/json',
    'consumerKey': '--consumer-key--'
};

var options = {
    url: 'https://api.qordoba.com/v2/countries',
    headers: headers
};

function callback(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
}

request(options, callback);
A binary file was returned

You couldn't be authenticated

{
  "countries": [
    {
      "id": 1,
      "code": "ad",
      "name": "Andorra",
      "currency": "eur",
      "iso_code": "and"
    },
{
  "fault": {
    "faultstring": "Invalid ApiKey for given resource",
    "detail": {
      "errorcode": "oauth.v2.InvalidApiKeyForGivenResource"
    }
  }
}

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

 
Suggest Edits

list languages

Returns the language detail list.

 
gethttps://api.qordoba.com/v2/languages
curl -i -X GET \
   -H "Accept:application/json" \
   -H "consumerKey:--consumer_key--" \
 'https://api.qordoba.com/v2/languages'
require 'net/http'
require 'uri'

uri = URI.parse("https://api.qordoba.com/v2/languages")
request = Net::HTTP::Get.new(uri)
request["Accept"] = "application/json"
request["Consumerkey"] = "--consumer-key--"

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end
import requests

headers = {
    'Accept': 'application/json',
    'consumerKey': '--consumer_key--',
}

requests.get('https://api.qordoba.com/v2/languages', headers=headers)
var request = require('request');

var headers = {
    'Accept': 'application/json',
    'consumerKey': '--consumer-key--'
};

var options = {
    url: 'https://api.qordoba.com/v2/languages',
    headers: headers
};

function callback(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
}

request(options, callback);
<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'Accept' => 'application/json',
    'consumerKey' => '--consumer_key--'
);
$response = Requests::get('https://api.qordoba.com/v2/languages', $headers);
A binary file was returned

You couldn't be authenticated

{
  "languages": [
    {
      "id": 94,
      "name": "English - United States",
      "code": "en-us",
      "direction": "ltr",
      "override_order": "aaa - aaa - English - United States"
    },
{
  "fault": {
    "faultstring": "Invalid ApiKey for given resource",
    "detail": {
      "errorcode": "oauth.v2.InvalidApiKeyForGivenResource"
    }
  }
}

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

 
Suggest Edits

Organization

 

Get information about your organization's team members.

Suggest Edits

list team

Returns a list of team members in the organization.

 
gethttps://api.qordoba.com/v2/organizations/team
curl -i -X GET \
   -H "Accept:application/json" \
   -H "consumerKey:--consumer_key--" \
   -H "organizationId:--organization_id--" \
 'https://api.qordoba.com/v2/organizations/team'
require 'net/http'
require 'uri'

uri = URI.parse("https://api.qordoba.com/v2/organizations/team")
request = Net::HTTP::Get.new(uri)
request["Accept"] = "application/json"
request["Consumerkey"] = "--consumer_key--"
request["Organizationid"] = "--organization_id--"

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

# response.code
# response.body
import requests

headers = {
    'Accept': 'application/json',
    'consumerKey': '--consumer_key--',
    'organizationId': '--organization_id--',
}

requests.get('https://api.qordoba.com/v2/organizations/team', headers=headers)
var request = require('request');

var headers = {
    'Accept': 'application/json',
    'consumerKey': '--consumer_key--',
    'organizationId': '--organization_id--'
};

var options = {
    url: 'https://api.qordoba.com/v2/organizations/team',
    headers: headers
};

function callback(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
}

request(options, callback);
<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'Accept' => 'application/json',
    'consumerKey' => '--consumer_key--',
    'organizationId' => '--organization_id--'
);
$response = Requests::get('https://api.qordoba.com/v2/organizations/team', $headers);
A binary file was returned

You couldn't be authenticated

{
	"memberCount": 60,
	"team":[
		{
			"memberId": 0,
			"memberName": "Jane Roe",
			"memberEmail": "jane@sample.org",
			"memberRole": "admin",
			"memberStatus": "signed_up",
			"memberTitle": "Lead Editor, Sample"
		},
		{"memberId": 6, "memberName": "Number Six",},
  ]
}
{
  "fault": {
    "faultstring": "Invalid ApiKey for given resource",
    "detail": {
      "errorcode": "oauth.v2.InvalidApiKeyForGivenResource"
    }
  }
}

Query Params

offset
string

The number of team members to skip before starting the list.

limit
string

The maximum number of team members to list.

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

organizationId
string
required

The organization ID, which can be copied from the URL and Settings.

 
 

Get information about your projects.

Suggest Edits

list projects

Returns a list of projects that belong to an organization, including some project details.

 
gethttps://api.qordoba.com/v2/projects/list
curl -i -X GET \
   -H "Accept:application/json" \
   -H "consumerKey:--consumer_key--" \
   -H "organizationId:--organization_id--" \
 'https://api.qordoba.com/v2/projects/list?offset=0&limit=3&search=--search_string--'
require 'net/http'
require 'uri'

uri = URI.parse("https://api.qordoba.com/v2/projects/list")
request = Net::HTTP::Get.new(uri)
request["Accept"] = "application/json"
request["Consumerkey"] = "--consumer_key--"
request["Organizationid"] = "--organization_id--"

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

# response.code
# response.body
import requests

headers = {
    'Accept': 'application/json',
    'consumerKey': '--consumer_key--',
    'organizationId': '--organization_id--',
}

requests.get('https://api.qordoba.com/v2/projects/list', headers=headers)
var request = require('request');

var headers = {
    'Accept': 'application/json',
    'consumerKey': '--consumer_key--',
    'organizationId': '--organization_id--'
};

var options = {
    url: 'https://api.qordoba.com/v2/projects/list',
    headers: headers
};

function callback(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
}

request(options, callback);
<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'Accept' => 'application/json',
    'consumerKey' => '--consumer_key--',
    'organizationId' => '--organization_id--'
);
$response = Requests::get('https://api.qordoba.com/v2/projects/list', $headers);
A binary file was returned

You couldn't be authenticated

{
  projectCount: 999,
  projects [
    {
      "id": 000,
      "name": "Product Test",
	    "creator": "John Doe",
	    "created": 1485366552000,
	    "sourceCode": "en-us",
	    "sourceId": 94,
	    "status": 1
		},...
	]
}
{
  "fault": {
    "faultstring": "Invalid ApiKey for given resource",
    "detail": {
      "errorcode": "oauth.v2.InvalidApiKeyForGivenResource"
    }
  }
}

Query Params

offset
string
limit
string
search
string

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

organizationId
string
required

The organization ID, which can be copied from the URL and Settings.

 
Suggest Edits

show project detail

Returns detailed information about a project.

 
gethttps://api.qordoba.com/v2/projects/detail
curl -i -X GET \
   -H "Accept:application/json" \
   -H "consumerKey:--consumer_key--" \
   -H "projectId:--project_id--" \
 'https://api.qordoba.com/v2/projects/detail'
require 'net/http'
require 'uri'

uri = URI.parse("https://api.qordoba.com/v2/projects/detail")
request = Net::HTTP::Get.new(uri)
request["Accept"] = "application/json"
request["Consumerkey"] = "--consumer_key--"
request["Projectid"] = "--project_id--"

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

# response.code
# response.body
import requests

headers = {
    'Accept': 'application/json',
    'consumerKey': '--consumer_key--',
    'projectId': '--project_id--',
}

requests.get('https://api.qordoba.com/v2/projects/detail', headers=headers)
var request = require('request');

var headers = {
    'Accept': 'application/json',
    'consumerKey': '--consumer_key--',
    'projectId': '--project_id--'
};

var options = {
    url: 'https://api.qordoba.com/v2/projects/detail',
    headers: headers
};

function callback(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
}

request(options, callback);
<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'Accept' => 'application/json',
    'consumerKey' => '--consumer_key--',
    'projectId' => '--project_id--'
);
$response = Requests::get('https://api.qordoba.com/v2/projects/detail', $headers);
A binary file was returned

You couldn't be authenticated

{
  "id": 0000,
  "name": "Sample Project",
  "creator": "Jane Roe",
  "creatorId": 0000,
  "created": 1477949364000,
  "sourceId": 94,
  "sourceCode": "en-us",
  "targeLanguages": [
    {
      "targetId": 124,
      "targetCode": "de-de",
      "targetGlossary": 2961
    }
  ],
  "typeCodes": [
    {
      "typeId": 11,
      "typeCode": "excel"
    }
  ],
  "segmentation": "default",
  "timezone": "PST8PDT"
}
{
  "fault": {
    "faultstring": "Invalid ApiKey for given resource",
    "detail": {
      "errorcode": "oauth.v2.InvalidApiKeyForGivenResource"
    }
  }
}

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

projectId
string
required

The project ID found by calling https://api.qordoba.com/v2/projects/list

 
Suggest Edits

show project status

Returns the status of all projects, or projects filtered by a target language.

 
gethttps://api.qordoba.com/v2/projects/status
curl -i -X GET \
   -H "Accept:application/json" \
   -H "consumerKey:--consumer_id--" \
   -H "projectId:--project_id--" \
 'https://api.qordoba.com/v2/projects/status?language=234'
require 'net/http'
require 'uri'

uri = URI.parse("https://api.qordoba.com/v2/projects/status?language=124")
request = Net::HTTP::Get.new(uri)
request["Accept"] = "application/json"
request["Consumerkey"] = "--consumer_id--"
request["Projectid"] = "--project_id--"

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

# response.code
# response.body
import requests

headers = {
    'Accept': 'application/json',
    'consumerKey': '--consumer_id--',
    'projectId': '--project_id--',
}

requests.get('https://api.qordoba.com/v2/projects/status?language=124', headers=headers)
var request = require('request');

var headers = {
    'Accept': 'application/json',
    'consumerKey': '--consumer_id--',
    'projectId': '--project_id--'
};

var options = {
    url: 'https://api.qordoba.com/v2/projects/status?language=124',
    headers: headers
};

function callback(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
}

request(options, callback);
<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'Accept' => 'application/json',
    'consumerKey' => '--consumer_id--',
    'projectId' => '--project_id--'
);
$response = Requests::get('https://api.qordoba.com/v2/projects/status?language=124', $headers);
A binary file was returned

You couldn't be authenticated

{
  "languages": [
    {
      "id": 234,
      "code": "es-es",
      "name": "Spanish - Spain",
      "segments": 285,
      "words": 1052,
      "total": 285,
      "total_words": 1052,
      "milestones": [
        {
          "id": -100,
          "name": "Completed",
          "order": 1000,
          "count": 76,
          "words_count": 258,
          "percent": 26.67
        },...
      ]
   ]
}
{
  "total": 111,
  "pages": [
    {
      "id": 730246,
      "name": "common.json",
      "title": "common.json",
      "url": "2b0c8b4e-b64d-415e-b9b7-9f97e3f7c7b0_common.json",
      "words": 6,
      "segments": 2,
      "milestones": [
        {
          "id": 8248,
          "count": 0,
          "percent": 0
        },
        {
          "id": 8249,
          "count": 0,
          "percent": 0
        },
        {
          "id": -100,
          "count": 2,
          "percent": 100
        }
      ]
    },
    {
      "id": 730558,
      "name": "jumbo.json",
      "title": "jumbo.json",
      "url": "3f56d754-044c-4aef-835f-7c7aa075503c_jumbo.json",
      "words": 0,
      "segments": 0,
      "milestones": [
        {
          "id": 8248,
          "count": 0,
          "percent": 0
        },
        {
          "id": 8249,
          "count": 0,
          "percent": 0
        },
        {
          "id": -100,
          "count": 0,
          "percent": 0
        }
      ]
    }
  ]
}

Query Params

language
string

The target language by which to filter the projects.

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

projectId
string
required

The project ID found by calling https://api.qordoba.com/v2/projects/list

 
Suggest Edits

show project workflow

Returns the milestone information, status, and language for a project.

 
gethttps://api.qordoba.com/v2/projects/workflow
curl -i -X GET \
   -H "Accept:application/json" \
   -H "consumerKey:--consumer_key--" \
   -H "projectId:--project_id--" \
 'https://api.qordoba.com/v2/projects/workflow'
require 'net/http'
require 'uri'

uri = URI.parse("https://api.qordoba.com/v2/projects/workflow")
request = Net::HTTP::Get.new(uri)
request["Accept"] = "application/json"
request["Consumerkey"] = "--consumer_key--"
request["Projectid"] = "--project_id--"

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

# response.code
# response.body
import requests

headers = {
    'Accept': 'application/json',
    'consumerKey': '--consumer_key--',
    'projectId': '--project_id--',
}

requests.get('https://api.qordoba.com/v2/projects/workflow', headers=headers)
var request = require('request');

var headers = {
    'Accept': 'application/json',
    'consumerKey': '--consumer_key--',
    'projectId': '--project_id--'
};

var options = {
    url: 'https://api.qordoba.com/v2/projects/workflow',
    headers: headers
};

function callback(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
}

request(options, callback);
<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'Accept' => 'application/json',
    'consumerKey' => '--consumer_key--',
    'projectId' => '--project_id--'
);
$response = Requests::get('https://api.qordoba.com/v2/projects/workflow', $headers);
A binary file was returned

You couldn't be authenticated

{
  "lastSaved": "September 30, 2014 12:00:00",
  "milestones":[
    {
      "milestoneId": 8248,
      "milestoneName": "Editing",
      "milestoneLanguages":[
        {
          "milestoneLanguageId": 22706,
          "code": "es-es",
          "status": "TODO"
        },
        {"milestoneLangaugeId": 22712, "code": "da-dk", "status": "TODO"},
        {"milestoneLangaugeId": 22916, "code": "en-gb", "status": "TODO"}
      ]
    },
    {"milestoneId": 8249, "milestoneName": "Proofreading",}
  ]
}
{
  "fault": {
    "faultstring": "Invalid ApiKey for given resource",
    "detail": {
      "errorcode": "oauth.v2.InvalidApiKeyForGivenResource"
    }
  }
}

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

projectId
string
required

The project ID found by calling https://api.qordoba.com/v2/projects/list

 

Securely manage your files

Suggest Edits

list files

Returns a list of project files for a given target language.

 
posthttps://api.qordoba.com/v2/files/list
curl -i -X POST \
   -H "Accept:application/json" \
   -H "consumerKey:--consumer_key--" \
   -H "projectId:--project_id--" \
   -H "languageId:--language_id--" \
   -H "Content-Type:application/json" \
   -d \
'{}' \
 'https://api.qordoba.com/v2/projects/files/list?offset=0&limit=6'
require 'net/http'
require 'uri'
require 'json'

uri = URI.parse("https://api.qordoba.com/v2/projects/files/list?offset=0&limit=6")
request = Net::HTTP::Post.new(uri)
request.content_type = "application/json"
request["Accept"] = "application/json"
request["Consumerkey"] = "--consumer_key--"
request["Projectid"] = "--project_id--"
request["Languageid"] = "--language_id--"
request.body = JSON.dump(
})

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

# response.code
# response.body
import requests

headers = {
    'Accept': 'application/json',
    'consumerKey': '--consumer_key--',
    'projectId': '--project_id--',
    'languageId': '--language_id--',
    'Content-Type': 'application/json',
}

data = '{}'

requests.post('https://api.qordoba.com/v2/projects/files/list?offset=0&limit=6', headers=headers, data=data)
var request = require('request');

var headers = {
    'Accept': 'application/json',
    'consumerKey': '--consumer_key--',
    'projectId': '--project_id--',
    'languageId': '--language_id--',
    'Content-Type': 'application/json'
};

var dataString = '{}';

var options = {
    url: 'https://api.qordoba.com/v2/projects/files/list?offset=0&limit=6',
    method: 'POST',
    headers: headers,
    body: dataString
};

function callback(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
}

request(options, callback);
<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'Accept' => 'application/json',
    'consumerKey' => '--consumer_key--',
    'projectId' => '--project_id--',
    'languageId' => '--language_id--',
    'Content-Type' => 'application/json'
);
$data = '{}';
$response = Requests::post('https://api.qordoba.com/v2/projects/files/list?offset=0&limit=6', $headers, $data);
A binary file was returned

You couldn't be authenticated

[
  {
    "id": 000000,
    "fileId": 000000,
    "enabled": true,
    "completed": false,
    "fileName": "sample.json",
    "segmentCount": 2,
    "updated": 1485473148000,
    "preparing": false,
    "deleted": false,
    "versionTag": "0.0"
  },
{
  "fault": {
    "faultstring": "Invalid ApiKey for given resource",
    "detail": {
      "errorcode": "oauth.v2.InvalidApiKeyForGivenResource"
    }
  }
}

Query Params

offset
string

The number of files to skip before starting the list.

limit
string

The maximum number of files to list.

Body Params

title
string

The file title by which to filter project files. Select * from the files table, where file-title LIKE %title% Empty means show all.

status
array of strings

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

projectId
string
required

The project ID found by calling https://api.qordoba.com/v2/projects/list

languageId
string
required

The language ID of the target language.

 

Advanced Options

Populate the payload:

{
  "title":"sample",
  "status":["enabled"]
}
Suggest Edits

list file types

Returns a list of the file types in a project.

 
gethttps://api.qordoba.com/v2/files/types
curl -i -X GET \
   -H "Accept:application/json" \
   -H "consumerKey:--consumer_key--" \
   -H "projectId:--product_id--" \
 'https://api.qordoba.com/v2/files/types'
require 'net/http'
require 'uri'

uri = URI.parse("https://api.qordoba.com/v2/files/types")
request = Net::HTTP::Get.new(uri)
request["Accept"] = "application/json"
request["Consumerkey"] = "--consumer_key--"
request["Projectid"] = "--product_id--"

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

# response.code
# response.body
import requests

headers = {
    'Accept': 'application/json',
    'consumerKey': '--consumer_key--',
    'projectId': '--product_id--',
}

requests.get('https://api.qordoba.com/v2/files/types', headers=headers)
var request = require('request');

var headers = {
    'Accept': 'application/json',
    'consumerKey': '--consumer_key--',
    'projectId': '--product_id--'
};

var options = {
    url: 'https://api.qordoba.com/v2/files/types',
    headers: headers
};

function callback(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
}

request(options, callback);
<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'Accept' => 'application/json',
    'consumerKey' => '--consumer_key--',
    'projectId' => '--product_id--'
);
$response = Requests::get('https://api.qordoba.com/v2/files/types', $headers);
A binary file was returned

You couldn't be authenticated

[
  {
    "typeId": 13,
    "typeCode": "regex"
  },
  {
    "typeId": 148,
    "typeCode": "JSON"
  }
]
{
  "fault": {
    "faultstring": "Invalid ApiKey for given resource",
    "detail": {
      "errorcode": "oauth.v2.InvalidApiKeyForGivenResource"
    }
  }
}

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

projectId
string
required

The project ID found by calling https://api.qordoba.com/v2/projects/list

 
Suggest Edits

export files

Returns a link for downloading a .zip file that contains project files for a specified page and target language.

 
posthttps://api.qordoba.com/v2/files/export
curl -i -X POST \
   -H "Content-Type:application/json" \
   -H "consumerKey:--consumer_key--" \
   -H "projectId:--project_id--" \
   -H "fileIds:--file_id--, --file_id2--" \
   -H "targetLanguageIds:--language_id--, --lanugage_id2--" \
   -d \
'' \
 'https://api.qordoba.com/v2/files/export'
require 'net/http'
require 'uri'
require 'json'

uri = URI.parse("https://api.qordoba.com/v2/files/export")
request = Net::HTTP::Post.new(uri)
request.content_type = "application/json"
request["Consumerkey"] = "--consumer_key--"
request["Projectid"] = "--project_id--"
request["Fileids"] = "--file_id--, file_id2--"
request["Targetlanguageids"] = "--target_language_id--, --target_language_id2--"
request.body = JSON.dump(
})

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

# response.code
# response.body
import requests

headers = {
    'Content-Type': 'application/json',
    'consumerKey': '--consumer_key--',
    'projectId': '--project_id--',
    'fileIds': '--file_id--, file_id2--',
    'targetLanguageIds': '--target_language_id--, --target_language_id2--',
}

data = '{}'

requests.post('https://api.qordoba.com/v2/files/export', headers=headers, data=data)
var request = require('request');

var headers = {
    'Content-Type': 'application/json',
    'consumerKey': '--consumer_key--',
    'projectId': '--project_id--',
    'fileIds': '--file_id--, file_id2--',
    'targetLanguageIds': '--target_language_id--, --target_language_id2--'
};

var dataString = '{}';

var options = {
    url: 'https://api.qordoba.com/v2/files/export',
    method: 'POST',
    headers: headers,
    body: dataString
};

function callback(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
}

request(options, callback);
<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'Content-Type' => 'application/json',
    'consumerKey' => '--consumer_key--',
    'projectId' => '--project_id--',
    'fileIds' => '--file_id--, file_id2--',
    'targetLanguageIds' => '--target_language_id--, --target_language_id2--'
);
$data = '{}';
$response = Requests::post('https://api.qordoba.com/v2/files/export', $headers, $data);
A binary file was returned

You couldn't be authenticated

{
  "downloadLink": "https://app.qordoba.com/api/file/download?token=abc123def456&filename=sample.zip"
}
{
  "fault": {
    "faultstring": "Invalid ApiKey for given resource",
    "detail": {
      "errorcode": "oauth.v2.InvalidApiKeyForGivenResource"
    }
  }
}

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

projectId
string
required

The project ID found by calling https://api.qordoba.com/v2/projects/list

fileIds
string
required

One or more file IDs separated by commas

targetLanguageIds
string
required

One or more language IDs separated by hyphens.

 
Suggest Edits

upload file

Uploads files to a project.

 
posthttps://api.qordoba.com/v2/files/upload
curl -i -X POST \
   -H "Accept:application/json" \
   -H "consumerKey:--consumer_key--" \
   -H "organizationId:--organization_id--" \
   -H "projectId:--project_id--" \
   -H "versionTag:--version_tag--" \
   -H "Content-Type:multipart/form-data" \
   -F "file=@\"./sample.json\";type=application/json;filename=\"sample.json\"" \
   -F "file_names=[]" \
 'https://api.qordoba.com/v2/files/upload?type=JSON'
require 'net/http'
require 'uri'

uri = URI.parse("https://api.qordoba.com/v2/files/upload?type=JSON")
request = Net::HTTP::Post.new(uri)
request.content_type = "multipart/form-data"
request["Accept"] = "application/json"
request["Consumerkey"] = "--consumer_key--"
request["Organizationid"] = "--organization_id--"
request["Projectid"] = "--project_id--"
request["Versiontag"] = "--version_tag--"

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

# response.code
# response.body
var request = require('request');

var headers = {
    'Accept': 'application/json',
    'consumerKey': '--consumer_key--',
    'organizationId': '--organization_id--',
    'projectId': '--project_id--',
    'versionTag': '--version_tag--',
    'Content-Type': 'multipart/form-data'
};

var options = {
    url: 'https://api.qordoba.com/v2/files/upload?type=JSON',
    method: 'POST',
    headers: headers
};

function callback(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
}

request(options, callback);
<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'Accept' => 'application/json',
    'consumerKey' => '--consumer_key--',
    'organizationId' => '--organization_id--',
    'projectId' => '--project_id--',
    'versionTag' => '--version_tag--',
    'Content-Type' => 'multipart/form-data'
);
$response = Requests::post('https://api.qordoba.com/v2/files/upload?type=JSON', $headers);
A binary file was returned

You couldn't be authenticated

{
  "result": "success",
  "files_ids":[
    000000
  ]
}
{
  "fault": {
    "faultstring": "Invalid ApiKey for given resource",
    "detail": {
      "errorcode": "oauth.v2.InvalidApiKeyForGivenResource"
    }
  }
}

Query Params

type
string
required

Content type. JSON only right now.

Body Params

file
file
required

File selection not yet supported at this reference page.

file_names
array of strings
required

Leave this as []

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

organizationId
string
required

The organization ID copied from the URL and Settings.

projectId
string
required

The project ID found by calling https://api.qordoba.com/v2/projects/list

versionTag
string

Optional version tag.

 
Suggest Edits

update file

Updates a file in a project.

 
posthttps://api.qordoba.com/v2/files/update
curl -i -X POST \
   -H "Accept:application/json" \
   -H "Content-Type:multipart/form-data" \
   -H "consumerKey:--consumer_key--" \
   -H "fileId:--file_id--" \
   -H "projectId:--project_id--" \
   -d \
'{}' \
 'https://api.qordoba.com/v2/files/update'
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

body
string
required

Headers

consumerKey
string
required
projectId
string
required
fileId
string
required
 
Suggest Edits

list file segments

Returns a list or filtered list, of the segments in a file.

 
gethttps://api.qordoba.com/v2/files/segments/list
curl -i -X GET \
   -H "Accept:application/json" \
   -H "consumerKey:--consumer_key--" \
   -H "projectId:--project_id--" \
   -H "languageId:--language_id--" \
   -H "fileId:--file_id--" \
 'https://api.qordoba.com/v2/files/segments/list?search=--string--'
require 'net/http'
require 'uri'

uri = URI.parse("https://api.qordoba.com/v2/files/segments/list?search=--string--")
request = Net::HTTP::Get.new(uri)
request["Accept"] = "application/json"
request["Consumerkey"] = "--consumer_key--"
request["Projectid"] = "--project_id--"
request["Languageid"] = "--language_id--"
request["Fileid"] = "--file_id--"

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

# response.code
# response.body
import requests

headers = {
    'Accept': 'application/json',
    'consumerKey': '--consumer_key--',
    'projectId': '--project_id--',
    'languageId': '--language_id--',
    'fileId': '--file_id--',
}

requests.get('https://api.qordoba.com/v2/files/segments/list?search=--string--', headers=headers)
var request = require('request');

var headers = {
    'Accept': 'application/json',
    'consumerKey': '--consumer_key--',
    'projectId': '--project_id--',
    'languageId': '--language_id--',
    'fileId': '--file_id--'
};

var options = {
    url: 'https://api.qordoba.com/v2/files/segments/list?search=--string--',
    headers: headers
};

function callback(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
}

request(options, callback);
<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'Accept' => 'application/json',
    'consumerKey' => '--consumer_key--',
    'projectId' => '--project_id--',
    'languageId' => '--language_id--',
    'fileId' => '--file_id--'
);
$response = Requests::get('https://api.qordoba.com/v2/files/segments/list?search=--string--', $headers);
A binary file was returned

You couldn't be authenticated

{
  "segmentCount": 5,
  "sourceId": 94,
  "sourceCode": "en-us",
  "targetId": 124,
  "targetCode": "de-de",
  "segments":[
    {
      "segmentId": 0000000,
      "segment": "And where is the prince who can so afford",
      "translationId": 0000000,
      "translation": null,
      "lastSaved": 1477949383000
    },
    {"segmentId": 00000001, "segment": "A rich and buttery history:",},
    {"segmentId": 00000002, "segment": "2016",},
  ]
}
{
  "fault": {
    "faultstring": "Invalid ApiKey for given resource",
    "detail": {
      "errorcode": "oauth.v2.InvalidApiKeyForGivenResource"
    }
  }
}

Query Params

offset
string

The number of segments to skip before starting the list.

limit
string

The maximum number of segments to list.

filter
string

The string by which to filter the list.

search
string

The search term

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

projectId
string
required

The project ID found by calling https://api.qordoba.com/v2/projects/list

languageId
string
required

The language ID of the target language.

fileId
string
required

The file ID of the file.

 
Suggest Edits

show file segment

Returns a file segment by its id.

 
gethttps://api.qordoba.com/v2/files/segments/show
curl -i -X GET \
   -H "Accept:application/json" \
   -H "consumerKey:--consumer_key--" \
   -H "projectId:--project_id--" \
   -H "languageId:--language_id--" \
   -H "fileId:--file_id--" \
   -H "segmentId:--segment_id--" \
 'https://api.qordoba.com/v2/files/segments/show'
require 'net/http'
require 'uri'

uri = URI.parse("https://api.qordoba.com/v2/files/segments/show")
request = Net::HTTP::Get.new(uri)
request["Accept"] = "application/json"
request["Consumerkey"] = "--consumer_key--"
request["Projectid"] = "--project_id--"
request["Languageid"] = "--language_id--"
request["Fileid"] = "--file_id--"
request["Segmentid"] = "--segment_id--"

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

# response.code
# response.body
import requests

headers = {
    'Accept': 'application/json',
    'consumerKey': '--consumer_key--',
    'projectId': '--project_id--',
    'languageId': '--language_id--',
    'fileId': '--file_id--',
    'segmentId': '--segment_id--',
}

requests.get('https://api.qordoba.com/v2/files/segments/show', headers=headers)
var request = require('request');

var headers = {
    'Accept': 'application/json',
    'consumerKey': '--consumer_key--',
    'projectId': '--project_id--',
    'languageId': '--language_id--',
    'fileId': '--file_id--',
    'segmentId': '--segment_id--'
};

var options = {
    url: 'https://api.qordoba.com/v2/files/segments/show',
    headers: headers
};

function callback(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
}

request(options, callback);
<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'Accept' => 'application/json',
    'consumerKey' => '--consumer_key--',
    'projectId' => '--project_id--',
    'languageId' => '--language_id--',
    'fileId' => '--file_id--',
    'segmentId' => '--segment_id--'
);
$response = Requests::get('https://api.qordoba.com/v2/files/segments/show', $headers);
A binary file was returned

You couldn't be authenticated

{
  "segmentId": 00000000,
  "segment": "You eat cookies.",
  "translationId": 000000000,
  "translation": "Sie Kekse essen.",
  "ssMatch": 89.78119659423828,
  "ssText": "Sie essen Kekse."
  },
  "last_saved": 1479508028000
}
{
  "fault": {
    "faultstring": "Invalid ApiKey for given resource",
    "detail": {
      "errorcode": "oauth.v2.InvalidApiKeyForGivenResource"
    }
  }
}

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

projectId
string
required

The project ID found by calling https://api.qordoba.com/v2/projects/list

languageId
string
required

The language ID of the target language.

fileId
string
required

The file ID of the file.

segmentId
string
required

The segment ID of the segment.

 
Suggest Edits

update file segments

Deletes or disables file segment settings.

 
puthttps://api.qordoba.com/v2/files/segments/update
curl -i -X PUT \
   -H "consumerKey:--consumer_key--" \
   -H "projectId:--project_id--" \
   -H "languageId:--language_id--" \
   -H "fileId:--file_id--" \
   -H "segmentId:--segment_id--" \
   -d \
'{
  "project_id":"--project_id--",
  "language_id":"--language_id--",
  "state":"enabled",
  "new_value":false,
  "apply_to":{
    "settings_ids":[--settings_ids--]
  }
}' \
 'https://api.qordoba.com/v2/segments/update'
require 'net/http'
require 'uri'

uri = URI.parse("https://api.qordoba.com/v2/segments/update")
request = Net::HTTP::Put.new(uri)
request["Consumerkey"] = "--consumer_key--"
request["Projectid"] = "--project_id--"
request["Languageid"] = "--language_id--"
request["Fileid"] = "--file_id--"
request["Segmentid"] = "--segment_id--"
request.body = "{
  \"project_id\":\"--project_id--\",
  \"language_id\":\"--language_id--\",
  \"state\":\"enabled\",
  \"new_value\":false,
  \"apply_to\":{
    \"settings_ids\":[--settings_ids--]
  }
}"

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

# response.code
# response.body
import requests

headers = {
    'consumerKey': '--consumer_key--',
    'projectId': '--project_id--',
    'languageId': '--language_id--',
    'fileId': '--file_id--',
    'segmentId': '--segment_id--',
}

data = '{
  "project_id":"--project_id--",
  "language_id":"--language_id--",
  "state":"enabled",
  "new_value":false,
  "apply_to":{
    "settings_ids":[--settings_ids--]
  }
}'

requests.put('https://api.qordoba.com/v2/segments/update', headers=headers, data=data)
var request = require('request');

var headers = {
    'consumerKey': '--consumer_key--',
    'projectId': '--project_id--',
    'languageId': '--language_id--',
    'fileId': '--file_id--',
    'segmentId': '--segment_id--'
};

var dataString = '{
  "project_id":"--project_id--",
  "language_id":"--language_id--",
  "state":"enabled",
  "new_value":false,
  "apply_to":{
    "settings_ids":[--settings_ids--]
  }
}';

var options = {
    url: 'https://api.qordoba.com/v2/segments/update',
    method: 'PUT',
    headers: headers,
    body: dataString
};

function callback(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
}

request(options, callback);
<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'consumerKey' => '--consumer_key--',
    'projectId' => '--project_id--',
    'languageId' => '--language_id--',
    'fileId' => '--file_id--',
    'segmentId' => '--segment_id--'
);
$data = '{
  "project_id":"--project_id--",
  "language_id":"--language_id--",
  "state":"enabled",
  "new_value":false,
  "apply_to":{
    "settings_ids":[--settings_ids--]
  }
}';
$response = Requests::put('https://api.qordoba.com/v2/segments/update', $headers, $data);
A binary file was returned

You couldn't be authenticated

{
  "Status": "Ok"
}
{
  "fault": {
    "faultstring": "Invalid ApiKey for given resource",
    "detail": {
      "errorcode": "oauth.v2.InvalidApiKeyForGivenResource"
    }
  }
}

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

projectId
string
required

The project ID found by calling https://api.qordoba.com/v2/projects/list

languageId
string
required

The language ID of the target language.

fileId
string
required

The file ID of the file.

segmentId
string
required

The segment ID of the segment.

 
Suggest Edits

value by key

Returns a key-value pair with context.

 
gethttps://api.qordoba.com/v2/files/value_by_key
curl -i -X GET \
   -H "consumerKey:--consumer_key--" \
   -H "projectId:--project_id--" \
   -H "languageId:--language_id--" \
   -H "fileId:--file_id--" \
   -H "milestoneId:--milestone_id--" \
 'https://api.qordoba.com/v2/files/value_by_key?searcString&searchCondition=is&searchTarget=segment&matchCase=false&searchReplace=false&wholeWord=false&offset=0&limit=6&filter'
curl -i -X GET \
   -H "consumerKey:--consumer_key--" \
   -H "projectId:--project_id--" \
   -H "languageId:--language_id--" \
   -H "fileId:--file_id--" \
   -H "milestoneId:--milestone_id--" \
 'https://api.qordoba.com/v2/files/value_by_key?searcString&searchCondition=is&searchTarget=segment&matchCase=false&searchReplace=false&wholeWord=false&offset=0&limit=6&filter' 'https://api.qordoba.com/v2/segments/show'
import requests

headers = {
    'consumerKey': '--consumer_key--',
    'projectId': '--project_id--',
    'languageId': '--language_id--',
    'fileId': '--file_id--',
    'milestoneId': '--milestone_id--',
}

requests.get('https://api.qordoba.com/v2/files/value_by_key?searcString&searchCondition=is&searchTarget=segment&matchCase=false&searchReplace=false&wholeWord=false&offset=0&limit=6&filter', headers=headers)
var request = require('request');

var headers = {
    'consumerKey': '--consumer_key--',
    'projectId': '--project_id--',
    'languageId': '--language_id--',
    'fileId': '--file_id--',
    'milestoneId': '--milestone_id--'
};

var options = {
    url: 'https://api.qordoba.com/v2/files/value_by_key?searcString&searchCondition=is&searchTarget=segment&matchCase=false&searchReplace=false&wholeWord=false&offset=0&limit=6&filter',
    headers: headers
};

function callback(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
}

request(options, callback);
<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'consumerKey' => '--consumer_key--',
    'projectId' => '--project_id--',
    'languageId' => '--language_id--',
    'fileId' => '--file_id--',
    'milestoneId' => '--milestone_id--'
);
$response = Requests::get('https://api.qordoba.com/v2/files/value_by_key?searcString&searchCondition=is&searchTarget=segment&matchCase=false&searchReplace=false&wholeWord=false&offset=0&limit=6&filter', $headers);
A binary file was returned

You couldn't be authenticated

{
  "resultCount": 6,
  "sourceId": 94,
  "sourceCode": "en-us",
  "targetId": 124,
  "targetCode": "de-de",
  "segments":[
    {
      "segmentId": 00000000,
      "segment": "Cookie Cam!",
      "reference": null,
      "plurals": null,
      "translationId": 000000000,
      "translation": "Keks Kam!",
      "pluralRule": null,
      "order": null,
      "stringKey": ""
    },
  {"segmentId": 0000001, "segment": "sample.org", "reference": null,},
  ]
}
{
  "fault": {
    "faultstring": "Invalid ApiKey for given resource",
    "detail": {
      "errorcode": "oauth.v2.InvalidApiKeyForGivenResource"
    }
  }
}

Query Params

offset
string

The number of key-value pairs to skip before starting the list.

limit
string

The maximum number of key-pairs to list.

filter
string

The string by which to filter the list.

search
string

The search term.

searchCondition
string

is, contains, begins_with, ends_with

searchTarget
string

The type of search target.

searchReplace
boolean

Whether to replace the search string.

matchCase
boolean

Whether to match the case of the search string.

wholeWord
boolean

Whether to search for the search string as a whole word.

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

projectId
string
required

The project ID found by calling https://api.qordoba.com/v2/projects/list

languageId
string
required

The ID of the target language.

fileId
string
required

The ID of the file.

milestoneId
string
required

The ID of the milestone.

 
Suggest Edits

Translation Memory

 

Securely manage your translation memories.

Suggest Edits

list translation memories

Returns a list or filtered list of translation memories, with links to download translation memory files and metadata.

 
gethttps://api.qordoba.com/v2/tms/list
curl -i -X GET \
   -H "Accept:application/json" \
   -H "consumerKey:--consumer_key--" \
   -H "organizationId:--organization_id--" \
 'https://api.qordoba.com/v2/tms/list?search=--search_string--'
require 'net/http'
require 'uri'

uri = URI.parse("https://api.qordoba.com/v2/tms/list?search=--search_string--")
request = Net::HTTP::Get.new(uri)
request["Accept"] = "application/json"
request["Consumerkey"] = "--consumer_key--"
request["Organizationid"] = "--organization_id--"

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

# response.code
# response.body
import requests

headers = {
    'Accept': 'application/json',
    'consumerKey': '--consumer_key--',
    'organizationId': '--organization_id--',
}

requests.get('https://api.qordoba.com/v2/tms/list?search=--search_string--', headers=headers)
var request = require('request');

var headers = {
    'Accept': 'application/json',
    'consumerKey': '--consumer_key--',
    'organizationId': '--organization_id--'
};

var options = {
    url: 'https://api.qordoba.com/v2/tms/list?search=--search_string--',
    headers: headers
};

function callback(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
}

request(options, callback);
<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'Accept' => 'application/json',
    'consumerKey' => '--consumer_key--',
    'organizationId' => '--organization_id--'
);
$response = Requests::get('https://api.qordoba.com/v2/tms/list?search=--search_string--', $headers);
A binary file was returned

You couldn't be authenticated

{
  "tmCount": 144,
  "tms": [
    {
      "tmId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "name": "sample TM",
      "sourceId": 94,
      "sourceCode": "en-us",
      "sourceDirection": "ltr",
      "targetId": 234,
      "targetCode": "es-es",
      "targetDirection": "ltr",
      "segmentsCount": 288,
      "created": 1484845180000,
      "createdBy": "Jane Roe"
    }
  ]
}
{
  "fault": {
    "faultstring": "Invalid ApiKey for given resource",
    "detail": {
      "errorcode": "oauth.v2.InvalidApiKeyForGivenResource"
    }
  }
}

Query Params

offset
string

The number of translation memories to skip before starting the list.

limit
string

The maximum number of translation memories to list.

search
string

The search term

orderType
string

The type of order to apply to the list.

order
string

The order to apply to the list.

language
string

The language by which to filter the list.

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

organizationId
string
required

The organization ID, which can be copied from the URL and Settings.

 

Without the optional search string and constraints, this call returns all of the organization translation memories.

Suggest Edits

show translation memory

Shows translation memory details by translation memory id.

 
gethttps://api.qordoba.com/v2/tms/show
curl -i -X GET \
   -H "Accept:application/json" \
   -H "consumerKey:--consumer_key--" \
   -H "organizationId:--organization_id--" \
   -H "tmId:--translation_memory_id--" \
 'https://api.qordoba.com/v2/tms/show?search=--search_string--'
require 'net/http'
require 'uri'

uri = URI.parse("https://api.qordoba.com/v2/tms/show?search=--search_string--")
request = Net::HTTP::Get.new(uri)
request["Accept"] = "application/json"
request["Consumerkey"] = "--consumer_key--"
request["Organizationid"] = "--organization_id--"
request["Tmid"] = "--translation_memory_id--"

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

# response.code
# response.body
import requests

headers = {
    'Accept': 'application/json',
    'consumerKey': '--consumer_key--',
    'organizationId': '--organization_id--',
    'tmId': '--translation_memory_id--',
}

requests.get('https://api.qordoba.com/v2/tms/show?search=--search_string--', headers=headers)
var request = require('request');

var headers = {
    'Accept': 'application/json',
    'consumerKey': '--consumer_key--',
    'organizationId': '--organization_id--',
    'tmId': '--translation_memory_id--'
};

var options = {
    url: 'https://api.qordoba.com/v2/tms/show?search=--search_string--',
    headers: headers
};

function callback(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
}

request(options, callback);
<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'Accept' => 'application/json',
    'consumerKey' => '--consumer_key--',
    'organizationId' => '--organization_id--',
    'tmId' => '--translation_memory_id--'
);
$response = Requests::get('https://api.qordoba.com/v2/tms/show?search=--search_string--', $headers);
A binary file was returned

You couldn't be authenticated

{
  "resultsCount": 22,
  "tmId": "xxxxxxxx-0000-xxxx-xxxx-xxxxxxxxxxxx",
  "name": "sample",
  "downloadUrl": "/organizations/0000/translation_memories/xxxxxxxx-0000-xxxx-xxxx-xxxxxxxxxxxx/download",
  "sourceId": 94,
  "sourceCode": "en-us",
  "targetId": 234,
  "targetCode": "es-es",
  "created": 1484845180000,
  "updated": 1485839472000,
  "segmentsCount": 1,
  "segments": [
    {
      "segmentId": 0000000,
      "segment": "the plural form 6",
      "translation": "La forma plural",
      "created": 1485806347543,
      "createdBy": "Jane Roe",
      "updated": 1485806347529
    }
  ],
  "linkedProjects": [
    {
      "projectId": 0000,
      "name": "sample"
    },
    {
      "projectId": 0001,
      "name": "sample1"
    },
    {
      "projectId": 0002,
      "name": "sample2"
    }
  ]
}
{
  "fault": {
    "faultstring": "Invalid ApiKey for given resource",
    "detail": {
      "errorcode": "oauth.v2.InvalidApiKeyForGivenResource"
    }
  }
}

Query Params

offset
string

The number of segments to skip before starting the list.

limit
string

The maximum number of segments to list.

search
string

The search term applied to segments.

Headers

consumerKey
string
required

The security key, which can be found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

organizationId
string
required

The organization ID, which can be copied from the URL and Settings.

tmId
string
required

The ID of the translation memory

 
Suggest Edits

upload translation memory

Uploads a new translation memory file.

 
posthttps://api.qordoba.com/v2/tms/upload
curl -i -X POST \
   -H "Accept:application/json" \
   -H "consumerKey:--consumer_key--" \
   -H "organizationId:--organization_id--" \
   -H "Content-Type:application/json" \
   -d \
'{}' \
 'https://api.qordoba.com/v2/tms/upload'
A binary file was returned

You couldn't be authenticated

{
  "fault": {
    "faultstring": "Invalid ApiKey for given resource",
    "detail": {
      "errorcode": "oauth.v2.InvalidApiKeyForGivenResource"
    }
  }
}

Body Params

payload
object

The payload file.

 

Headers

consumerKey
string
required

The security key, which can be found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

organizationId
string
required

The organization ID, which can be copied from the URL and Settings.

 
Suggest Edits

list tm segments

Returns all translation memory segments.

 
gethttps://api.qordoba.com/v2/tms/segments/list
curl -i -X GET \
   -H "Accept:application/json" \
   -H "consumerKey:--consumer_key--" \
   -H "organizationId:--organization_id--" \
   -H "tmId:--translation_memory_id--" \
 'https://api.qordoba.com/v2/tms/segments/list?search=--search_string--'
require 'net/http'
require 'uri'

uri = URI.parse("https://api.qordoba.com/v2/tms/segments/list?search=--search_string--")
request = Net::HTTP::Get.new(uri)
request["Accept"] = "application/json"
request["Consumerkey"] = "--consumer_key--"
request["Organizationid"] = "--organization_id--"
request["Tmid"] = "--translation_memory_id--"

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

# response.code
# response.body
import requests

headers = {
    'Accept': 'application/json',
    'consumerKey': '--consumer_key--',
    'organizationId': '--organization_id--',
    'tmId': '--translation_memory_id--',
}

requests.get('https://api.qordoba.com/v2/tms/segments/list?search=--search_string--', headers=headers)
var request = require('request');

var headers = {
    'Accept': 'application/json',
    'consumerKey': '--consumer_key--',
    'organizationId': '--organization_id--',
    'tmId': '--translation_memory_id--'
};

var options = {
    url: 'https://api.qordoba.com/v2/tms/segments/list?search=--search_string--',
    headers: headers
};

function callback(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
}

request(options, callback);
<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'Accept' => 'application/json',
    'consumerKey' => '--consumer_key--',
    'organizationId' => '--organization_id--',
    'tmId' => '--translation_memory_id--'
);
$response = Requests::get('https://api.qordoba.com/v2/tms/segments/list?search=--search_string--', $headers);
A binary file was returned

You couldn't be authenticated

{
  "segmentCount": 12,
  "segments": [
    {
      "segmentId": "0000000",
      "segment": "the plural form 6",
      "translation": "La forma plural",
    },
    {"segmentId": "0000001", "segment": "test one hundred",},
		{"segmentId": "0000002", "segment": "Esta es una aplicación",},
  ]
}
{
  "fault": {
    "faultstring": "Invalid ApiKey for given resource",
    "detail": {
      "errorcode": "oauth.v2.InvalidApiKeyForGivenResource"
    }
  }
}

Query Params

offset
string

The number of translation memory segments to skip before starting the list.

limit
string

The maximum number of translation memory segments to list.

search
string

The search term applied to segments.

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

organizationId
string
required

The organization ID, which can be copied from the URL and Settings.

tmId
string
required

The ID of the translation memory.

 
Suggest Edits

add tm segment

Adds a new segment to existing translation memory.

 
posthttps://api.qordoba.com/v2/tms/segments/add
curl -i -X POST \
   -H "Accept:application/json" \
   -H "consumerKey:--consumer_key--" \
   -H "organizationId:--organization_id--" \
   -H "Content-Type:application/json" \
   -d \
'{}' \
 'https://api.qordoba.com/v2/tms/segments/add'
A binary file was returned

You couldn't be authenticated

{
  "fault": {
    "faultstring": "Invalid ApiKey for given resource",
    "detail": {
      "errorcode": "oauth.v2.InvalidApiKeyForGivenResource"
    }
  }
}

Body Params

payload
object

The payload that contains the segment.

 

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

organizationId
string
required

The organization ID, which can be copied from the URL and Settings.

 

/organizations/:organization_id/translation_memories/add_term

Suggest Edits

update tm segment

Updates a translation memory segment.

 
puthttps://api.qordoba.com/v2/tms/segments/update
curl -i -X PUT \
   -H "Accept:application/json" \
   -H "consumerKey:--consumer_key--" \
   -H "organizationId:--organization_id--" \
   -H "Content-Type:application/json" \
   -H "tmId:--translation_memory_id--" \
   -H "segmentId:--segment_id--" \
   -d \
'{}' \
 'https://api.qordoba.com/v2/tms/segments/update'
A binary file was returned

You couldn't be authenticated

{
  "fault": {
    "faultstring": "Invalid ApiKey for given resource",
    "detail": {
      "errorcode": "oauth.v2.InvalidApiKeyForGivenResource"
    }
  }
}

Body Params

payload
object

The payload that contains the segment.

 

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

organiztionId
string
required

The organization ID, which can be copied from the URL and Settings.

tmId
string
required

The ID of the translation memory.

segmentId
string
required

The ID of the segment.

 

/organizations/:organization_id/translation_memories/:translation_memory_id/segments/:term_id

Suggest Edits

delete tm segment

Deletes a translation memory segment.

 
deletehttps://api.qordoba.com/v2/tms/segments/delete
curl -i -X DELETE \
   -H "Accept:application/json" \
   -H "consumerKey:--consumer_key--" \
   -H "organizationId:--organization_id--" \
   -H "tmId:--translation_memory_id--" \
   -H "segmentId:--segment_id--" \
 'https://api.qordoba.com/v2/tms/segments/delete'
A binary file was returned

You couldn't be authenticated

{
  "fault": {
    "faultstring": "Invalid ApiKey for given resource",
    "detail": {
      "errorcode": "oauth.v2.InvalidApiKeyForGivenResource"
    }
  }
}

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

organizationId
string
required

The organization ID, which can be copied from the URL and Settings.

tmId
string
required

The ID of the translation memory

segmentId
string
required

The ID of the segment

 

/organizations/:organization_id/translation_memories/:translation_memory_id/segments/:term_id

 

Securely manage your glossaries.

Suggest Edits

list glossaries

Returns a list or filtered list of glossaries, with links to download glossaries and metadata.

 
gethttps://api.qordoba.com/v2/glossaries/list
curl -i -X GET \
   -H "Content-Type:application/json" \
   -H "consumerKey:--consumer_key--" \
   -H "organizationId:--organization_id--" \
 'https://api.qordoba.com/v2/glossaries/list?search=--search_string'
require 'net/http'
require 'uri'

uri = URI.parse("https://api.qordoba.com/v2/glossaries/list?search=--search_string")
request = Net::HTTP::Get.new(uri)
request.content_type = "application/json"
request["Consumerkey"] = "--consumer_key--"
request["Organizationid"] = "--organization_id--"

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

# response.code
# response.body
import requests

headers = {
    'Content-Type': 'application/json',
    'consumerKey': '--consumer_key--',
    'organizationId': '--organization_id--',
}

requests.get('https://api.qordoba.com/v2/glossaries/list?search=--search_string', headers=headers)
var request = require('request');

var headers = {
    'Content-Type': 'application/json',
    'consumerKey': '--consumer_key--',
    'organizationId': '--organization_id--'
};

var options = {
    url: 'https://api.qordoba.com/v2/glossaries/list?search=--search_string',
    headers: headers
};

function callback(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
}

request(options, callback);
<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'Content-Type' => 'application/json',
    'consumerKey' => '--consumer_key--',
    'organizationId' => '--organization_id--'
);
$response = Requests::get('https://api.qordoba.com/v2/glossaries/list?search=--search_string', $headers);
A binary file was returned

You couldn't be authenticated

{
  "glossaryCount": 000,
  "glossaries": [
    {
      "glossaryId": 0000,
      "glossaryName": "sampleGlossary",
      "sourceId": 94,
      "sourceCode": "en-us",
      "targetId": 124,
      "targetCode": "de-de",
      "created": 1485717360000,
      "createdBy": "Jane Roe",
      "updated": 1485717360000,
      "segmentsCount": 0,
    }
  ]
}
{
  "fault": {
    "faultstring": "Invalid ApiKey for given resource",
    "detail": {
      "errorcode": "oauth.v2.InvalidApiKeyForGivenResource"
    }
  }
}

Query Params

offset
string

The number of glossaries to skip before starting the list.

limit
string

The maximum number of glossaries to list.

search
string

The search term

language
string

The numerical ID of the target language ID

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

organizationId
string
required

The organization ID, which can be copied from the URL and Settings.

 
Suggest Edits

show glossary

Shows glossary details by translation memory id.

 
gethttps://api.qordoba.com/v2/glossaries/show
curl -i -X GET \
   -H "Content-Type:application/json" \
   -H "consumerKey:--consumer_key--" \
   -H "organizationId:--organization_id--" \
   -H "glossaryId:--glossary_id--" \
 'https://api.qordoba.com/v2/glossaries/show?search=--search_string--'
require 'net/http'
require 'uri'

uri = URI.parse("https://api.qordoba.com/v2/glossaries/show?search=--search_string--")
request = Net::HTTP::Get.new(uri)
request.content_type = "application/json"
request["Consumerkey"] = "--consumer_key--"
request["Organizationid"] = "--organization_id--"
request["Glossaryid"] = "--glossary_id--"

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

# response.code
# response.body
import requests

headers = {
    'Content-Type': 'application/json',
    'consumerKey': '--consumer_key--',
    'organizationId': '--organization_id--',
    'glossaryId': '--glossary_id--',
}

requests.get('https://api.qordoba.com/v2/glossaries/show?search=--search_string--', headers=headers)
var request = require('request');

var headers = {
    'Content-Type': 'application/json',
    'consumerKey': '--consumer_key--',
    'organizationId': '--organization_id--',
    'glossaryId': '--glossary_id--'
};

var options = {
    url: 'https://api.qordoba.com/v2/glossaries/show?search=--search_string--',
    headers: headers
};

function callback(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
}

request(options, callback);
<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'Content-Type' => 'application/json',
    'consumerKey' => '--consumer_key--',
    'organizationId' => '--organization_id--',
    'glossaryId' => '--glossary_id--'
);
$response = Requests::get('https://api.qordoba.com/v2/glossaries/show?search=--search_string--', $headers);
A binary file was returned

You couldn't be authenticated

{
  "glossaryId": 00000,
  "glossaryName": "sample Glossary",
  "sourceId": 94,
  "sourceCode": "en-us",
  "sourceDirection": "ltr",
  "targetId": 124,
  "targetCode": "de-de",
  "targetDirection": "ltr",
  "created": 1477949364000,
  "createdBy": "Jane Roe",
  "updated": 1479507644000,
  "updatedBy": "John Doe",
  "segmentsCount": 2,
  "segments": [
    {
      "sourceId": 000000,
      "translations": "tranlsations"
    }
  ],
  "linkedProjects": [
    {
      "projectId": 0000,
      "projectName": "sample project"
    },
  ]
}
{
  "fault": {
    "faultstring": "Invalid ApiKey for given resource",
    "detail": {
      "errorcode": "oauth.v2.InvalidApiKeyForGivenResource"
    }
  }
}

Query Params

offset
string

The number of glossaries details to skip before starting the list.

limit
string

The maximum number of glossaries to list.

search
string

The search term

Headers

consumerKey
string

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

organizationId
string
required

The organization ID, which can be copied from the URL and Settings.

glossaryId
string
required

The ID of the glossary

 

/glossaries/:glossary_id

Suggest Edits

upload glossary

Uploads a glossary file.

 
posthttps://api.qordoba.com/v2/glossaries/upload
curl -i -X POST \
   -H "Content-Type:application/json" \
   -H "consumerKey:--consumer_key--" \
   -H "organizationId:--organization_id--" \
   -d \
'{}' \
 'https://api.qordoba.com/v2/glossaries/upload'
A binary file was returned

You couldn't be authenticated

{
  "fault": {
    "faultstring": "Invalid ApiKey for given resource",
    "detail": {
      "errorcode": "oauth.v2.InvalidApiKeyForGivenResource"
    }
  }
}

Body Params

payload
object
required

The payload file

 

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

organizationId
string
required

The organization ID, which can be copied from the URL and Settings.

 
Suggest Edits

add glossary term

Adds a new term to a glossary.

 
posthttps://api.qordoba.com/v2/glossaries/terms/add
curl -i -X POST \
   -H "Content-Type:application/json" \
   -H "consumerKey:--consumer_key--" \
   -H "glossaryId:--glossary_id--" \
   -H "organizationId:--organization_id--" \
   -d \
'{}' \
 'https://api.qordoba.com/v2/glossaries/terms/add'
A binary file was returned

You couldn't be authenticated

{
  "fault": {
    "faultstring": "Invalid ApiKey for given resource",
    "detail": {
      "errorcode": "oauth.v2.InvalidApiKeyForGivenResource"
    }
  }
}

Body Params

payload
object

The payload file

 

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

organizationId
string
required

The organization ID, which can be copied from the URL and Settings.

glossaryId
string
required

The ID of the glossary.

 

SmartSuggest is Qordoba’s proprietary machine translation technology. It fuses machine learning with real-life translation activity to recommend content for your target languages. Each segment comes replete with confidence levels.

An informed recommendation intended to serve as a guide, SmartSuggest will continue to get smarter as you continue to translate content.

With Qordoba's upcoming SmartSuggest API you will be able to integrate real-time human-enhanced machine translation with your chat apps, user feedback forums, and more.

Suggest Edits

Translate Names

Translate one name from source language to target language.

 
posthttps://api.qordoba.com/v2/smart/translate/names
curl -i -X POST \
   -H "consumerKey:--consumer_key--" \
   -H "organizationId:--organization_id--" \
   -H "sourceLanguageId:--source_id--" \
   -H "targetLanguageId:--target_id--" \
   -H "Content-Type:application/json" \
   -d \
'{
  "name": "Abraham Lincoln"
}' \
 'https://api.qordoba.com/v2/smart/translate/names'
require 'net/http'
require 'uri'
require 'json'

uri = URI.parse("https://api.qordoba.com/v2/smart/translate/names")
request = Net::HTTP::Post.new(uri)
request.content_type = "application/json"
request["Consumerkey"] = "--consumer_key--"
request["Organizationid"] = "--organization_id--"
request["Sourcelanguageid"] = "--source_id--"
request["Targetlanguageid"] = "--target_id--"
request.body = JSON.dump({
  "name" => "Abraham Lincoln"
})

req_options = {
  use_ssl: uri.scheme == "https",
}

response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
  http.request(request)
end

# response.code
# response.body
import requests

headers = {
    'consumerKey': '--consumer_key--',
    'organizationId': '--organization_id--',
    'sourceLanguageId': '--source_id--',
    'targetLanguageId': '--target_id--',
    'Content-Type': 'application/json',
}

data = '{
  "name": "Abraham Lincoln"
}'

requests.post('https://api.qordoba.com/v2/smart/translate/names', headers=headers, data=data)
var request = require('request');

var headers = {
    'consumerKey': '--consumer_key--',
    'organizationId': '--organization_id--',
    'sourceLanguageId': '--source_id--',
    'targetLanguageId': '--target_id--',
    'Content-Type': 'application/json'
};

var dataString = '{
  "name": "Abraham Lincoln"
}';

var options = {
    url: 'https://api.qordoba.com/v2/smart/translate/names',
    method: 'POST',
    headers: headers,
    body: dataString
};

function callback(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
}

request(options, callback);
<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'consumerKey' => '--consumer_key--',
    'organizationId' => '--organization_id--',
    'sourceLanguageId' => '--source_id--',
    'targetLanguageId' => '--target_id--',
    'Content-Type' => 'application/json'
);
$data = '{
  "name": "Abraham Lincoln"
}';
$response = Requests::post('https://api.qordoba.com/v2/smart/translate/names', $headers, $data);
A binary file was returned

You couldn't be authenticated

{
"text": "ابراهام لينكولن"
}

Body Params

name
string
required

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

organizationId
string
required

The organization ID, which can be copied from the URL and Settings.

sourceLanguageId
string
required

numeric id of source language

targetLanguageId
string
required

numeric id of target language

 
Suggest Edits

Translate Addresses

Translate one or more addresses from source language to target language.

 
posthttps://api.qordoba.com/v2/smart/translate/addresses
curl -i -X POST \
   -H "Content-Type:application/json" \
   -H "consumerKey:--consumer_key--" \
   -H "organizationId:--organization_id--" \
   -H "sourceLanguageId:--source_id--" \
   -H "targetLanguageId:--target_id--" \
   -d \
'{
  "addresses": ["300 Brannan St #420, San Francisco CA 94107"]
}' \
 'https://api.qordoba.com/v2/translate/addresses'
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

addresses
array of strings
required

address(s) to translate

Headers

consumerKey
string
required

visit http://developers.account.qordoba.com/ and click "MyApps".

organizationId
string
required

The organization ID, which can be copied from the URL and Settings.

sourceLanguageId
string
required

numeric id of source language

targetLanguageId
string
required

numeric id of target language

 
Suggest Edits

Translate Segements

Translate one or more text strings from source language to target language.

 
posthttps://api.qordoba.com/v2/smart/translate/segments
curl --request POST \
  --url https://api.qordoba.com/v2/smart/translate/segments \
  --header 'consumerkey: consumerKey' \
  --header 'organizationid: organizationId' \
  --header 'sourcelanguageid: sourceLanguageId' \
  --header 'targetlanguageid: targetLanguageId'
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.qordoba.com/v2/smart/translate/segments',
  headers: 
   { targetlanguageid: 'targetLanguageId',
     sourcelanguageid: 'sourceLanguageId',
     organizationid: 'organizationId',
     consumerkey: 'consumerKey' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qordoba.com/v2/smart/translate/segments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["consumerkey"] = 'consumerKey'
request["organizationid"] = 'organizationId'
request["sourcelanguageid"] = 'sourceLanguageId'
request["targetlanguageid"] = 'targetLanguageId'

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.qordoba.com/v2/smart/translate/segments");
xhr.setRequestHeader("consumerkey", "consumerKey");
xhr.setRequestHeader("organizationid", "organizationId");
xhr.setRequestHeader("sourcelanguageid", "sourceLanguageId");
xhr.setRequestHeader("targetlanguageid", "targetLanguageId");

xhr.send(data);
import requests

url = "https://api.qordoba.com/v2/smart/translate/segments"

headers = {
    'consumerkey': "consumerKey",
    'organizationid': "organizationId",
    'sourcelanguageid': "sourceLanguageId",
    'targetlanguageid': "targetLanguageId"
    }

response = requests.request("POST", url, headers=headers)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

segments
array of strings
required

segment(s) to translate

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

organizationId
string
required

The organization ID, which can be copied from the URL and Settings.

sourceLanguageId
string
required

numeric id of source language

targetLanguageId
string
required

numeric id of target language

 

Translates input text from the source language to the target language.

Suggest Edits

Detect Affect

Identify affect or mood.

 
posthttps://api.qordoba.com/v2/smart/affect
curl --request POST \
  --url https://api.qordoba.com/v2/smart/affect \
  --header 'consumerkey: consumerKey' \
  --header 'organizationid: organizationId' \
  --header 'sourcelanguageid: sourceLanguageId'
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.qordoba.com/v2/smart/affect',
  headers: 
   { sourcelanguageid: 'sourceLanguageId',
     organizationid: 'organizationId',
     consumerkey: 'consumerKey' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qordoba.com/v2/smart/affect")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["consumerkey"] = 'consumerKey'
request["organizationid"] = 'organizationId'
request["sourcelanguageid"] = 'sourceLanguageId'

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.qordoba.com/v2/smart/affect");
xhr.setRequestHeader("consumerkey", "consumerKey");
xhr.setRequestHeader("organizationid", "organizationId");
xhr.setRequestHeader("sourcelanguageid", "sourceLanguageId");

xhr.send(data);
import requests

url = "https://api.qordoba.com/v2/smart/affect"

headers = {
    'consumerkey': "consumerKey",
    'organizationid': "organizationId",
    'sourcelanguageid': "sourceLanguageId"
    }

response = requests.request("POST", url, headers=headers)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

segment
string
required

segment to detect

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

organizationId
string
required
sourceLanguageId
string
required

numeric id of source language

 
Suggest Edits

Auto Summarize

Automatically summarizes information.

 
posthttps://api.qordoba.com/v2/smart/summarize
curl --request POST \
  --url https://api.qordoba.com/v2/smart/summarize \
  --header 'consumerkey: consumerKey' \
  --header 'organizationid: organizationId' \
  --header 'sourcelanguageid: sourceLanguageId'
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.qordoba.com/v2/smart/summarize',
  headers: 
   { sourcelanguageid: 'sourceLanguageId',
     organizationid: 'organizationId',
     consumerkey: 'consumerKey' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qordoba.com/v2/smart/summarize")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["consumerkey"] = 'consumerKey'
request["organizationid"] = 'organizationId'
request["sourcelanguageid"] = 'sourceLanguageId'

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.qordoba.com/v2/smart/summarize");
xhr.setRequestHeader("consumerkey", "consumerKey");
xhr.setRequestHeader("organizationid", "organizationId");
xhr.setRequestHeader("sourcelanguageid", "sourceLanguageId");

xhr.send(data);
import requests

url = "https://api.qordoba.com/v2/smart/summarize"

headers = {
    'consumerkey': "consumerKey",
    'organizationid': "organizationId",
    'sourcelanguageid': "sourceLanguageId"
    }

response = requests.request("POST", url, headers=headers)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

segment
string
required

segment to summarize

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

organizationId
string
required
sourceLanguageId
string
required

numeric id of source language

 
Suggest Edits

TM Fuzzy Match

Performs fuzzy matches using translation memory.

 
posthttps://api.qordoba.com/v2/smart/fuzzy
curl --request POST \
  --url https://api.qordoba.com/v2/smart/fuzzy \
  --header 'consumerkey: consumerKey' \
  --header 'organizationid: organizationId' \
  --header 'sourcelanguageid: sourceLanguageId' \
  --header 'tmid: tmId'
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.qordoba.com/v2/smart/fuzzy',
  headers: 
   { sourcelanguageid: 'sourceLanguageId',
     tmid: 'tmId',
     organizationid: 'organizationId',
     consumerkey: 'consumerKey' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qordoba.com/v2/smart/fuzzy")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["consumerkey"] = 'consumerKey'
request["organizationid"] = 'organizationId'
request["tmid"] = 'tmId'
request["sourcelanguageid"] = 'sourceLanguageId'

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.qordoba.com/v2/smart/fuzzy");
xhr.setRequestHeader("consumerkey", "consumerKey");
xhr.setRequestHeader("organizationid", "organizationId");
xhr.setRequestHeader("tmid", "tmId");
xhr.setRequestHeader("sourcelanguageid", "sourceLanguageId");

xhr.send(data);
import requests

url = "https://api.qordoba.com/v2/smart/fuzzy"

headers = {
    'consumerkey': "consumerKey",
    'organizationid': "organizationId",
    'tmid': "tmId",
    'sourcelanguageid': "sourceLanguageId"
    }

response = requests.request("POST", url, headers=headers)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

segment
string
required

segment to match

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

organizationId
string
required
tmId
string
required

tm to use for fuzzy match

sourceLanguageId
string
required

numeric id of source language

 
Suggest Edits

list supported languages

 
gethttps://api.qordoba.com/v2/rest/list_supported_languages
curl --request GET \
  --url https://api.qordoba.com/v2/rest/list_supported_languages \
  --header 'x-auth-token: 0a1c2bb1-d3e6-40d6-9674-1bd13f497758'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.qordoba.com/v2/rest/list_supported_languages',
  headers: 
   { 'x-auth-token': '0a1c2bb1-d3e6-40d6-9674-1bd13f497758' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qordoba.com/v2/rest/list_supported_languages")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-auth-token"] = '0a1c2bb1-d3e6-40d6-9674-1bd13f497758'

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qordoba.com/v2/rest/list_supported_languages");
xhr.setRequestHeader("x-auth-token", "0a1c2bb1-d3e6-40d6-9674-1bd13f497758");

xhr.send(data);
import requests

url = "https://api.qordoba.com/v2/rest/list_supported_languages"

headers = {'x-auth-token': '0a1c2bb1-d3e6-40d6-9674-1bd13f497758'}

response = requests.request("GET", url, headers=headers)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
    {
        "language_code": "en",
        "language_name": "English"
    },
    {
        "language_code": "en-US",
        "language_name": "English (US)"
    },
    {
        "language_code": "en-GB",
        "language_name": "English (GB)"
    },
    {
        "language_code": "en-AU",
        "language_name": "English (Australian)"
    },
    {
        "language_code": "en-CA",
        "language_name": "English (Canadian)"
    },
    {
        "language_code": "en-NZ",
        "language_name": "English (New Zealand)"
    },
    {
        "language_code": "en-ZA",
        "language_name": "English (South African)"
    },
    {
        "language_code": "fa",
        "language_name": "Persian"
    },
    {
        "language_code": "fr",
        "language_name": "French"
    },
    {
        "language_code": "de",
        "language_name": "German"
    },
    {
        "language_code": "de-DE",
        "language_name": "German (Germany)"
    },
    {
        "language_code": "de-AT",
        "language_name": "German (Austria)"
    },
    {
        "language_code": "de-CH",
        "language_name": "German (Swiss)"
    },
    {
        "language_code": "de-DE-x-simple-language",
        "language_name": "Simple German"
    },
    {
        "language_code": "pl-PL",
        "language_name": "Polish"
    },
    {
        "language_code": "ca-ES",
        "language_name": "Catalan"
    },
    {
        "language_code": "ca-ES-valencia",
        "language_name": "Catalan (Valencian)"
    },
    {
        "language_code": "it",
        "language_name": "Italian"
    },
    {
        "language_code": "br-FR",
        "language_name": "Breton"
    },
    {
        "language_code": "nl",
        "language_name": "Dutch"
    },
    {
        "language_code": "pt",
        "language_name": "Portuguese"
    },
    {
        "language_code": "pt-PT",
        "language_name": "Portuguese (Portugal)"
    },
    {
        "language_code": "pt-BR",
        "language_name": "Portuguese (Brazil)"
    },
    {
        "language_code": "pt-AO",
        "language_name": "Portuguese (Angola preAO)"
    },
    {
        "language_code": "pt-MZ",
        "language_name": "Portuguese (Moçambique preAO)"
    },
    {
        "language_code": "ru-RU",
        "language_name": "Russian"
    },
    {
        "language_code": "ast-ES",
        "language_name": "Asturian"
    },
    {
        "language_code": "be-BY",
        "language_name": "Belarusian"
    },
    {
        "language_code": "zh-CN",
        "language_name": "Chinese"
    },
    {
        "language_code": "da-DK",
        "language_name": "Danish"
    },
    {
        "language_code": "eo",
        "language_name": "Esperanto"
    },
    {
        "language_code": "gl-ES",
        "language_name": "Galician"
    },
    {
        "language_code": "el-GR",
        "language_name": "Greek"
    },
    {
        "language_code": "ja-JP",
        "language_name": "Japanese"
    },
    {
        "language_code": "km-KH",
        "language_name": "Khmer"
    },
    {
        "language_code": "ro-RO",
        "language_name": "Romanian"
    },
    {
        "language_code": "sk-SK",
        "language_name": "Slovak"
    },
    {
        "language_code": "sl-SI",
        "language_name": "Slovenian"
    },
    {
        "language_code": "es",
        "language_name": "Spanish"
    },
    {
        "language_code": "sv",
        "language_name": "Swedish"
    },
    {
        "language_code": "ta-IN",
        "language_name": "Tamil"
    },
    {
        "language_code": "tl-PH",
        "language_name": "Tagalog"
    },
    {
        "language_code": "uk-UA",
        "language_name": "Ukrainian"
    }
]

Headers

X-AUTH-TOKEN
string
required
 
Suggest Edits

Emotion and Style

 
posthttps://api.qordoba.com/v2/rest/tidata_score/languages/lang
curl --request POST \
  --url https://api.qordoba.com/v2/rest/tidata_score/languages/94
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.qordoba.com/v2/rest/tidata_score/languages/94' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qordoba.com/v2/rest/tidata_score/languages/94")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.qordoba.com/v2/rest/tidata_score/languages/94");

xhr.send(data);
import requests

url = "https://api.qordoba.com/v2/rest/tidata_score/languages/94"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "text": "",
    "categories": [
        {
            "name": "emotion",
            "labels": [
                {
                    "name": "Anger",
                    "value": 0.000001,
                    "ti_type": 2
                },
                {
                    "name": "Disgust",
                    "value": 0.000001,
                    "ti_type": 3
                },
                {
                    "name": "Fear",
                    "value": 0.000001,
                    "ti_type": 4
                },
                {
                    "name": "Joy",
                    "value": 0.529096,
                    "ti_type": 5
                },
                {
                    "name": "Sadness",
                    "value": 0.27691211111111114,
                    "ti_type": 6
                }
            ]
        },
        {
            "name": "tone",
            "labels": [
                {
                    "name": "Confident",
                    "value": 0.3290768,
                    "ti_type": 12
                },
                {
                    "name": "Tentative",
                    "value": 0.3921659310344828,
                    "ti_type": 11
                },
                {
                    "name": "Analytical",
                    "value": 0.860308,
                    "ti_type": 13
                }
            ]
        },
        {
            "name": "brand",
            "labels": [
                {
                    "name": "Neuroticism ",
                    "value": 0.000001,
                    "ti_type": 9
                },
                {
                    "name": "Conscientiousness",
                    "value": 0.000001,
                    "ti_type": 8
                },
                {
                    "name": "Extraversion",
                    "value": 0.000001,
                    "ti_type": 10
                },
                {
                    "name": "Openness",
                    "value": 0.000001,
                    "ti_type": 14
                },
                {
                    "name": "Agreeableness ",
                    "value": 0.000001,
                    "ti_type": 7
                }
            ]
        }
    ]
}

Path Params

lang
int32
required

Language in which text need to be analyzed

Body Params

data
json

Data to be analyzed

 
Suggest Edits

check grammar

 
posthttps://api.qordoba.com/v2/rest/check_segment_grammer/languages/lang
curl --request POST \
  --url https://api.qordoba.com/v2/rest/check_segment_grammer/languages/94 \
  --header 'x-auth-token: 0a1c2bb1-d3e6-40d6-9674-1bd13f497758'
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.qordoba.com/v2/rest/check_segment_grammer/languages/94',
  headers: 
   { 'x-auth-token': '0a1c2bb1-d3e6-40d6-9674-1bd13f497758' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qordoba.com/v2/rest/check_segment_grammer/languages/94")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-auth-token"] = '0a1c2bb1-d3e6-40d6-9674-1bd13f497758'

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.qordoba.com/v2/rest/check_segment_grammer/languages/94");
xhr.setRequestHeader("x-auth-token", "0a1c2bb1-d3e6-40d6-9674-1bd13f497758");

xhr.send(data);
import requests

url = "https://api.qordoba.com/v2/rest/check_segment_grammer/languages/94"

headers = {'x-auth-token': '0a1c2bb1-d3e6-40d6-9674-1bd13f497758'}

response = requests.request("POST", url, headers=headers)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
    {
        "from_position": 29,
        "to_position": 31,
        "message": "Don't put a space before the full stop",
        "suggested_replacements": "."
    }
]

Path Params

lang
string
required

Language in which the text should be analyzed

Body Params

data
json

The text that should be analyzed

Headers

X-AUTH-TOKEN
string
required
 
Suggest Edits

check grammar bulk

 
posthttps://api.qordoba.com/v2/rest/check_bulk/languages/lang
curl --request POST \
  --url https://api.qordoba.com/v2/rest/check_bulk/languages/94 \
  --header 'x-auth-token: 0a1c2bb1-d3e6-40d6-9674-1bd13f497758'
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.qordoba.com/v2/rest/check_bulk/languages/94',
  headers: 
   { 'x-auth-token': '0a1c2bb1-d3e6-40d6-9674-1bd13f497758' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qordoba.com/v2/rest/check_bulk/languages/94")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-auth-token"] = '0a1c2bb1-d3e6-40d6-9674-1bd13f497758'

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.qordoba.com/v2/rest/check_bulk/languages/94");
xhr.setRequestHeader("x-auth-token", "0a1c2bb1-d3e6-40d6-9674-1bd13f497758");

xhr.send(data);
import requests

url = "https://api.qordoba.com/v2/rest/check_bulk/languages/94"

headers = {'x-auth-token': '0a1c2bb1-d3e6-40d6-9674-1bd13f497758'}

response = requests.request("POST", url, headers=headers)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "key1": [
        {
            "from_position": 29,
            "to_position": 31,
            "message": "Don't put a space before the full stop",
            "suggested_replacements": "."
        }
    ],
    "key2": [
        {
            "from_position": 56,
            "to_position": 62,
            "message": "Possible spelling mistake found",
            "suggested_replacements": "amount | account | count | a count"
        }
    ],
    "key3": []
}

Path Params

lang
string
required

Body Params

data
json
required

Headers

X-AUTH-TOKEN
string
required
 
Suggest Edits

check grammer per file

 
gethttps://api.qordoba.com/v2/rest/check_page_grammer/languages/lang/projects/projId/qprojects/qProjectId/pages/qPageId
curl --request GET \
  --url https://api.qordoba.com/v2/rest/check_page_grammer/languages/94/projects/57/qprojects/1130/pages/353768 \
  --header 'x-auth-token: 0a1c2bb1-d3e6-40d6-9674-1bd13f497758'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.qordoba.com/v2/rest/check_page_grammer/languages/94/projects/57/qprojects/1130/pages/353768',
  headers: 
   { 'x-auth-token': '0a1c2bb1-d3e6-40d6-9674-1bd13f497758' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qordoba.com/v2/rest/check_page_grammer/languages/94/projects/57/qprojects/1130/pages/353768")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-auth-token"] = '0a1c2bb1-d3e6-40d6-9674-1bd13f497758'

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qordoba.com/v2/rest/check_page_grammer/languages/94/projects/57/qprojects/1130/pages/353768");
xhr.setRequestHeader("x-auth-token", "0a1c2bb1-d3e6-40d6-9674-1bd13f497758");

xhr.send(data);
import requests

url = "https://api.qordoba.com/v2/rest/check_page_grammer/languages/94/projects/57/qprojects/1130/pages/353768"

headers = {'x-auth-token': '0a1c2bb1-d3e6-40d6-9674-1bd13f497758'}

response = requests.request("GET", url, headers=headers)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "3576": [],
    "3577": [],
    "3578": [
        {
            "from_position": 0,
            "to_position": 5,
            "message": "This sentence does not start with an uppercase letter",
            "suggested_replacements": "Stood"
        }
    ],
    "3579": [
        {
            "from_position": 0,
            "to_position": 2,
            "message": "This sentence does not start with an uppercase letter",
            "suggested_replacements": "To"
        }
    ],
    "3580": [
        {
            "from_position": 0,
            "to_position": 5,
            "message": "This sentence does not start with an uppercase letter",
            "suggested_replacements": "Every"
        }
    ],
    "3581": [
        {
            "from_position": 0,
            "to_position": 1,
            "message": "Put a space after the comma, but not before the comma",
            "suggested_replacements": ","
        }
    ],
    "3582": [],
    "3583": [
        {
            "from_position": 0,
            "to_position": 6,
            "message": "This sentence does not start with an uppercase letter",
            "suggested_replacements": "Annual"
        }
    ],
    "3584": [],
    "3585": [
        {
            "from_position": 0,
            "to_position": 8,
            "message": "This sentence does not start with an uppercase letter",
            "suggested_replacements": "Campaign"
        }
    ],
    "3586": [
        {
            "from_position": 0,
            "to_position": 8,
            "message": "This sentence does not start with an uppercase letter",
            "suggested_replacements": "Donating"
        }
    ],
    "3587": [
        {
            "from_position": 0,
            "to_position": 2,
            "message": "This sentence does not start with an uppercase letter",
            "suggested_replacements": "Or"
        }
    ],
    "3588": [],
    "3589": [
        {
            "from_position": 0,
            "to_position": 9,
            "message": "Possible spelling mistake found",
            "suggested_replacements": "Postdates | Post mates"
        }
    ],
    "3590": [
        {
            "from_position": 0,
            "to_position": 9,
            "message": "Possible spelling mistake found",
            "suggested_replacements": "postdates | post mates"
        }
    ]
}

Path Params

lang
int32
required

Language used to analyze the text

projId
int32
required

Text Intelligence Project

qProjectId
int32
required

Qordoba Project Id

qPageId
int32
required

Qordoba Page Id

Query Params

page_size
int32

Number of segments to be be analyzed in a page

Headers

X-AUTH-TOKEN
string
required
 
Suggest Edits

Style check

 
posthttps://api.qordoba.com/v2/rest/analyze_text/languages/lang
curl --request POST \
  --url https://api.qordoba.com/v2/rest/analyze_text/languages/94 \
  --header 'x-auth-token: 0a1c2bb1-d3e6-40d6-9674-1bd13f497758'
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.qordoba.com/v2/rest/analyze_text/languages/94',
  headers: 
   { 'x-auth-token': '0a1c2bb1-d3e6-40d6-9674-1bd13f497758' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qordoba.com/v2/rest/analyze_text/languages/94")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-auth-token"] = '0a1c2bb1-d3e6-40d6-9674-1bd13f497758'

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.qordoba.com/v2/rest/analyze_text/languages/94");
xhr.setRequestHeader("x-auth-token", "0a1c2bb1-d3e6-40d6-9674-1bd13f497758");

xhr.send(data);
import requests

url = "https://api.qordoba.com/v2/rest/analyze_text/languages/94"

headers = {'x-auth-token': '0a1c2bb1-d3e6-40d6-9674-1bd13f497758'}

response = requests.request("POST", url, headers=headers)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "metrics": {
        "adjective_ratio": 0,
        "adverb_ratio": 0.08333333333333333,
        "bigram_freq": [],
        "character_count": 62,
        "characters_per_word": 4.333333333333333,
        "declarative_ratio": 0,
        "entity_substitution_ratio": 0.25,
        "exclamative_ratio": 0,
        "filler_ratio": 0,
        "interrogative_ratio": 0,
        "long_sentences_ratio": 0,
        "modal_ratio": 0.08333333333333333,
        "negation_ratio": 0,
        "nominalization_ratio": 0.25,
        "noun_cluster_ratio": 0,
        "noun_ratio": 0.25,
        "other_pos_ratio": 0.25000000000000006,
        "passive_voice_ratio": 0,
        "pronoun_ratio": 0.16666666666666666,
        "rare_word_ratio": 0.25,
        "readability": 0,
        "sentence_count": 1,
        "short_sentences_ratio": 0,
        "std_of_words_per_sentence": -1,
        "stopword_ratio": 0.4166666666666667,
        "syllables_per_word": 1.3,
        "trigram_freq": [],
        "verb_ratio": 0.25,
        "vocabulary_size": 11,
        "weak_verb_ratio": 0.3333333333333333,
        "word_count": 12,
        "word_freq": [],
        "words_per_sentence": 12
    },
    "text": "You'll first need to upgrade your account to a business acount",
    "tokens": {
        "entity_substitutions": [
            true,
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            false
        ],
        "expected_word_frequencies": [
            6847.002222,
            0,
            1068.66222256,
            781.38,
            22642.468884,
            0,
            1488.05777811,
            153.14888889,
            22642.468884,
            22542.66667,
            384.37333331,
            0
        ],
        "filler_words": [
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            false
        ],
        "negations": [
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            false
        ],
        "nominalizations": [
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            true,
            false
        ],
        "noun_clusters": [
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null
        ],
        "number_of_characters": [
            3,
            null,
            5,
            4,
            2,
            7,
            4,
            7,
            2,
            1,
            8,
            6
        ],
        "number_of_syllables": [
            1,
            null,
            1,
            1,
            1,
            2,
            1,
            2,
            1,
            1,
            2,
            null
        ],
        "parts_of_speech": [
            "PRP",
            "MD",
            "RB",
            "VBP",
            "TO",
            "VB",
            "PRP$",
            "NN",
            "TO",
            "DT",
            "NN",
            "NN"
        ],
        "passive_voice_cases": [
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null
        ],
        "sentence_end_punctuations": [
            "",
            "",
            "",
            "",
            "",
            "",
            "",
            "",
            "",
            "",
            "",
            ""
        ],
        "sentence_numbers": [
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1,
            1
        ],
        "stems": [
            "you",
            "'ll",
            "first",
            "need",
            "to",
            "upgrad",
            "your",
            "account",
            "to",
            "a",
            "busi",
            "acount"
        ],
        "stopwords": [
            true,
            false,
            false,
            false,
            true,
            false,
            true,
            false,
            true,
            true,
            false,
            false
        ],
        "synonyms": [
            [],
            [],
            [
                "firstly",
                "foremost"
            ],
            [
                "involve",
                "require",
                "necessitate",
                "take",
                "want",
                "demand",
                "ask",
                "postulate"
            ],
            [],
            [
                "advance",
                "promote",
                "raise",
                "elevate"
            ],
            [],
            [
                "story",
                "chronicle",
                "explanation",
                "bill",
                "score",
                "invoice",
                "report",
                "accounting",
                "history"
            ],
            [],
            [],
            [
                "patronage",
                "concern",
                "line",
                "job",
                "byplay",
                "clientele",
                "occupation"
            ],
            []
        ],
        "values": [
            "You",
            "'ll",
            "first",
            "need",
            "to",
            "upgrade",
            "your",
            "account",
            "to",
            "a",
            "business",
            "acount"
        ],
        "verb_groups": [
            null,
            1,
            null,
            1,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null
        ],
        "weak_verbs": [
            false,
            false,
            false,
            true,
            false,
            false,
            false,
            false,
            false,
            false,
            false,
            false
        ]
    }
}

Path Params

lang
string
required

Body Params

data
string

Text that need to be analyzed

Headers

X-AUTH-TOKEN
string
required
 
Suggest Edits

Style check per file

 
gethttps://api.qordoba.com/v2/rest/analyze_text_page/languages/lang/projects/projId/qprojects/qProjectId/pages/qPageId
curl --request GET \
  --url https://api.qordoba.com/v2/rest/analyze_text_page/languages/94/projects/57/qprojects/1130/pages/353768 \
  --header 'x-auth-token: 0a1c2bb1-d3e6-40d6-9674-1bd13f497758'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.qordoba.com/v2/rest/analyze_text_page/languages/94/projects/57/qprojects/1130/pages/353768',
  headers: 
   { 'x-auth-token': '0a1c2bb1-d3e6-40d6-9674-1bd13f497758' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qordoba.com/v2/rest/analyze_text_page/languages/94/projects/57/qprojects/1130/pages/353768")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-auth-token"] = '0a1c2bb1-d3e6-40d6-9674-1bd13f497758'

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qordoba.com/v2/rest/analyze_text_page/languages/94/projects/57/qprojects/1130/pages/353768");
xhr.setRequestHeader("x-auth-token", "0a1c2bb1-d3e6-40d6-9674-1bd13f497758");

xhr.send(data);
import requests

url = "https://api.qordoba.com/v2/rest/analyze_text_page/languages/94/projects/57/qprojects/1130/pages/353768"

headers = {'x-auth-token': '0a1c2bb1-d3e6-40d6-9674-1bd13f497758'}

response = requests.request("GET", url, headers=headers)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "text": "\"Upgrade to a business account\"",
    "weak_verbs_percentage": 0,
    "filler_words_percentage": 0,
    "nominalization_percentage": 33.33,
    "entity_substitutions_percentage": 0,
    "negations_percentage": 0,
    "clustered_nouns_percentage": 0,
    "passive_voice_percentage": 0,
    "modal_percentage": 0,
    "rare_words_percentage": 20,
    "long_sentences_percentage": 0,
    "short_sentences_percentage": 100,
    "weak_verbs": [
        false,
        false,
        false,
        false,
        false
    ],
    "filler_words": [
        false,
        false,
        false,
        false,
        false
    ],
    "nominalization": [
        false,
        false,
        false,
        true,
        false
    ],
    "entity_substitutions": [
        false,
        false,
        false,
        false,
        false
    ],
    "negations": [
        false,
        false,
        false,
        false,
        false
    ],
    "clustered_nouns": [
        null,
        null,
        null,
        null,
        null
    ],
    "passive_voice": [
        null,
        null,
        null,
        null,
        null
    ],
    "number_of_characters": [
        7,
        2,
        1,
        8,
        7
    ],
    "sentence_numbers": [
        1,
        1,
        1,
        1,
        1
    ],
    "synonyms": [
        [
            "acclivity",
            "raise",
            "rise",
            "climb",
            "ascent"
        ],
        [],
        [],
        [
            "patronage",
            "concern",
            "line",
            "job",
            "byplay",
            "clientele",
            "occupation"
        ],
        [
            "story",
            "chronicle",
            "explanation",
            "bill",
            "score",
            "invoice",
            "report",
            "accounting",
            "history"
        ]
    ]
}

Path Params

lang
int32
required

Language used to analyze the text

projId
int32
required

Text Intelligence Project

qProjectId
int32
required

Qordoba Project Id

qPageId
int32
required

Qordoba Page Id

Query Params

page_size
int32

Number of segments to be be analyzed in a page

Headers

X-AUTH-TOKEN
string
required
 
Suggest Edits

Emotion and Style Page level

 
gethttps://api.qordoba.com/v2/rest/get_tidata_sentences_page_score/languages/lang/projects/projId/qprojects/qProjId/pages/qPageId
curl --request GET \
  --url https://api.qordoba.com/v2/rest/get_tidata_sentences_page_score/languages/94/projects/57/qprojects/1130/pages/353768
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.qordoba.com/v2/rest/get_tidata_sentences_page_score/languages/94/projects/57/qprojects/1130/pages/353768' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qordoba.com/v2/rest/get_tidata_sentences_page_score/languages/94/projects/57/qprojects/1130/pages/353768")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qordoba.com/v2/rest/get_tidata_sentences_page_score/languages/94/projects/57/qprojects/1130/pages/353768");

xhr.send(data);
import requests

url = "https://api.qordoba.com/v2/rest/get_tidata_sentences_page_score/languages/94/projects/57/qprojects/1130/pages/353768"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "text": "",
    "categories": [
        {
            "name": "emotion",
            "labels": [
                {
                    "name": "Anger",
                    "value": 0.000001,
                    "ti_type": 2
                },
                {
                    "name": "Disgust",
                    "value": 0.000001,
                    "ti_type": 3
                },
                {
                    "name": "Fear",
                    "value": 0.000001,
                    "ti_type": 4
                },
                {
                    "name": "Joy",
                    "value": 0.529096,
                    "ti_type": 5
                },
                {
                    "name": "Sadness",
                    "value": 0.27691211111111114,
                    "ti_type": 6
                }
            ]
        },
        {
            "name": "tone",
            "labels": [
                {
                    "name": "Confident",
                    "value": 0.3290768,
                    "ti_type": 12
                },
                {
                    "name": "Tentative",
                    "value": 0.3921659310344828,
                    "ti_type": 11
                },
                {
                    "name": "Analytical",
                    "value": 0.860308,
                    "ti_type": 13
                }
            ]
        },
        {
            "name": "brand",
            "labels": [
                {
                    "name": "Neuroticism ",
                    "value": 0.000001,
                    "ti_type": 9
                },
                {
                    "name": "Conscientiousness",
                    "value": 0.000001,
                    "ti_type": 8
                },
                {
                    "name": "Extraversion",
                    "value": 0.000001,
                    "ti_type": 10
                },
                {
                    "name": "Openness",
                    "value": 0.000001,
                    "ti_type": 14
                },
                {
                    "name": "Agreeableness ",
                    "value": 0.000001,
                    "ti_type": 7
                }
            ]
        }
    ]
}

Path Params

lang
int32
required

Language in which the text should be analyzed

projId
int32
required

Text Intelligence Project Id

qProjId
int32
required

Qordoba Project Id

qPageId
int32
required

Qordoba Page Id

Headers

X-AUTH-TOKEN
string
 
Suggest Edits

Report per project

 
gethttps://api.qordoba.com/v2
curl --request GET \
  --url https://api.qordoba.com/v2
var request = require("request");

var options = { method: 'GET', url: 'https://api.qordoba.com/v2' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qordoba.com/v2")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qordoba.com/v2");

xhr.send(data);
import requests

url = "https://api.qordoba.com/v2"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
Suggest Edits

Report per file

 
gethttps://api.qordoba.com/v2
curl --request GET \
  --url https://api.qordoba.com/v2
var request = require("request");

var options = { method: 'GET', url: 'https://api.qordoba.com/v2' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qordoba.com/v2")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.qordoba.com/v2");

xhr.send(data);
import requests

url = "https://api.qordoba.com/v2"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
Suggest Edits

About

Qordoba experimental APIs

 

Qordoba Labs

Most Labs APIs will step you through the process of building a small application or adding a new feature to an existing application.

Suggest Edits

English to Emoji

Translate English to emoji. 😀

 
posthttps://api.qordoba.com/v2/tx/en-emoji
curl --request POST \
  --url https://api.qordoba.com/v2/tx/en-emoji \
  --header 'consumerkey: consumerKey' \
  --header 'projectid: projectId'
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.qordoba.com/v2/tx/en-emoji',
  headers: 
   { projectid: 'projectId',
     consumerkey: 'consumerKey' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qordoba.com/v2/tx/en-emoji")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["consumerkey"] = 'consumerKey'
request["projectid"] = 'projectId'

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.qordoba.com/v2/tx/en-emoji");
xhr.setRequestHeader("consumerkey", "consumerKey");
xhr.setRequestHeader("projectid", "projectId");

xhr.send(data);
import requests

url = "https://api.qordoba.com/v2/tx/en-emoji"

headers = {
    'consumerkey': "consumerKey",
    'projectid': "projectId"
    }

response = requests.request("POST", url, headers=headers)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

sourceSegment
object
required

segment to emojifi

 

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

projectId
string
 
Suggest Edits

English to Phoenician

Translate English to Phoenician.

 
posthttps://api.qordoba.com/v2/tx/en-phoenician
curl --request POST \
  --url https://api.qordoba.com/v2/tx/en-phoenician \
  --header 'consumerkey: consumerKey' \
  --header 'projectid: projectId'
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.qordoba.com/v2/tx/en-phoenician',
  headers: 
   { projectid: 'projectId',
     consumerkey: 'consumerKey' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qordoba.com/v2/tx/en-phoenician")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["consumerkey"] = 'consumerKey'
request["projectid"] = 'projectId'

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.qordoba.com/v2/tx/en-phoenician");
xhr.setRequestHeader("consumerkey", "consumerKey");
xhr.setRequestHeader("projectid", "projectId");

xhr.send(data);
import requests

url = "https://api.qordoba.com/v2/tx/en-phoenician"

headers = {
    'consumerkey': "consumerKey",
    'projectid': "projectId"
    }

response = requests.request("POST", url, headers=headers)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

sourceSegment
object
required

segment to Phoenicianize

 

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

projectId
string
 
Suggest Edits

English to Hieroglyphs

Translate English to hieroglyphs. 👁️➰🐞

 
posthttps://api.qordoba.com/v2/tx/en-hieroglyph
curl --request POST \
  --url https://api.qordoba.com/v2/tx/en-hieroglyph \
  --header 'consumerkey: consumerKey' \
  --header 'projectid: projectId'
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.qordoba.com/v2/tx/en-hieroglyph',
  headers: 
   { projectid: 'projectId',
     consumerkey: 'consumerKey' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.qordoba.com/v2/tx/en-hieroglyph")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["consumerkey"] = 'consumerKey'
request["projectid"] = 'projectId'

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.qordoba.com/v2/tx/en-hieroglyph");
xhr.setRequestHeader("consumerkey", "consumerKey");
xhr.setRequestHeader("projectid", "projectId");

xhr.send(data);
import requests

url = "https://api.qordoba.com/v2/tx/en-hieroglyph"

headers = {
    'consumerkey': "consumerKey",
    'projectid': "projectId"
    }

response = requests.request("POST", url, headers=headers)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

sourceSegment
object
required

segment to hieroglypherate

 

Headers

consumerKey
string
required

The security key found by visiting http://developers.account.qordoba.com/ and clicking "MyApps".

projectId
string