Developer API Reference

Record Status API

The record status determines the status of the associated record.

Root

https://api.ttskit.com/v1

Route

/status

Request Type

GET

Request Headers

Below are the list of Accepted Request Headers if you are trying to Read Voices.

Request Header	Value	Required
X-Master-Key	<API_KEY>	Yes
Content-Type	application/json	Yes

X-Master-Key Required

You will need this Key to access mostly any API end-point on TTSKit. You could find the key on the API Key page.

Content-Type Required

Set the Content-Type header to application/json. This needs to be passed with every request you make on the TTSKit. Failing to pass this in the Header will result in an error.

Request Query Parameters

Query Parameter	Value	Required
recordId	<RECORD_ID>	Yes

recordId Required

You can pass the above parameter along with the Recored Id which you could retrieve once you Create a Record.

Code Samples

cURL
Java
JavaScript (ES6)
Python 3
Ruby

curl -v\
    -H "Content-Type: application/json" \
    -H "X-Master-key: <YOUR_API_KEY>" \
    --request GET \
    https://api.ttskit.com/v1/status?recordId=<RECORD_ID>

    HttpGet get = new HttpGet("https://api.ttskit.com/v1/status");

    List<NameValuePair> urlParameters = new ArrayList<>();
    urlParameters.add(new BasicNameValuePair("recordId", "<RECORD_ID>"));

    get.addHeader("Content-Type", "application/json");
    get.addHeader("X-Master-Key", "<YOUR_API_KEY>");
    get.setEntity(new UrlEncodedFormEntity(urlParameters));

    try (CloseableHttpClient httpClient = HttpClients.createDefault();
            CloseableHttpResponse response = httpClient.execute(get)) {

        System.out.println(EntityUtils.toString(response.getEntity()));
    }

let req = new XMLHttpRequest();

req.onreadystatechange = () => {
    if (req.readyState == XMLHttpRequest.DONE) {
        console.log(req.responseText);
    }
};

req.open("GET", "https://api.ttskit.com/v1/status?recordId=<RECORD_ID>", true);
req.setRequestHeader("Content-Type", "application/json");
req.setRequestHeader("X-Master-Key", "<YOUR_API_KEY>");
req.send();

import requests
url = 'https://api.ttskit.com/v1/status?recordId=<RECORD_ID>'
headers = {
    'Content-Type': 'application/json',
    'X-Master-Key': '<YOUR_API_KEY>'
}

req = requests.get(url, json=None, headers=headers)
print(req.text)

require 'net/http'
require 'json'

uri = URI("https://api.ttskit.com/v1/status?recordId=<RECORD_ID>")
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
req = Net::HTTP::Get.new(uri)
req['Content-Type'] = 'application/json'
req['X-Master-Key'] = '<YOUR_API_KEY>'

http.request(req)
end

puts res.body

Request Response

Success Status Code: 200

{
    "code": 200,
    "message": "Success.",
    "status": "success",
    "record": {
        "id": "<RECORD_ID>",
        "status": "<RECORD_STATUS>",
        ....
    }
}

The following table lists the different status values for record.

Record Status	Description
INIT	Default status when you create a record.
ADDED	Changes to ADDED after the record is assigned to the WORKER.
IN_PROGRESS	Changes to IN_PROGRESS after the WORKER is started.
COMPLETED	Changes to COMPLETED after the WORKER successfully converted.
FAILED	Changes to FAILED after the WORKER conversion failed.
STREAM_DELETED	Changes to STREAM_DELETED after storage expires.

Error Status Code: 400, 401, 402, 404

{
    "code": 400,
    "message": "<Error Message>",
    "subMessage": "<Error Message Detail>",
    "status": "error"
}

For more information on the error codes & errors you might possibly encounter, refer to the below section.

Error Reference

400 Bad Request
401 UnAuthorized
402 Payment Required
404 Not Found

Invalid Route

To solve this issue, simply provide the correct Route.

You need to pass Content-Type set to application/json

You'll encounter this error if you are not passing the Content-Type header. Hence, pass the Content-Type header with a value of application/json.

Ensure your data complies with data constraints

You can refer to "subMessage" for more details.

You need to pass X-Master-Key in the header

You'll encounter this error if you are not passing the X-Master-Key header which is required to authenticate your request. In-order to fix this, pass the X-Master-Key header with a value of the API Key which you can find on the API Keys page.

X-Master-Key passed does not have permission to read the record.

Check if you are passing the right Record Id or the Id is valid but it does not belong to your account.

Currently, The API is only supported for premium users. Upgrade to Premium plan https://ttskit.com/pricing to use these features

You need to upgrade your account to the Premium Plan to use these features.

The Record was not found.

No record found with matching ID.

DEVELOPERS API REFERENCE (v1.0)