Trint

The Trint API Developer Hub

Welcome to the Trint API developer hub. You'll find comprehensive guides and documentation to help you start working with Trint API as quickly as possible, as well as support if you get stuck. Let's jump right in!

Guides    
Suggest Edits

/

Upload media files directly to Trint for immediate transcription

 
posthttps://upload.trint.com
curl -X POST \
  https://upload.trint.com/ \
  --data-binary @myfile.mp4 \
  -H 'api-key: APIKEY'
  -H 'content-type: video/mp4' \
  -H 'filename: myfile.mp4'
const request = require('request');
const fs = require('fs');

const myFile = fs.readFileSync('myFile.mp4');

const options = {
  method: 'POST',
  url: 'https://upload.trint.com/',
  encoding: null,
  body: myFile,
  headers: {
    'api-key': 'APIKEY',
    'content-type': 'video/mp4',
    filename: 'myFile.mp4',
  },
};

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

  console.log(body);
});
A binary file was returned

You couldn't be authenticated

{
  "trintId": "myTrintId"
}
Transcription blocked, insufficient credit

Query Params

api-key
string
required

API key authorization (required if using query parameters)

content-type
string
required

MIME type of the file being uploaded

language
string

Language to transcribe

filename
string

The name of the file being uploaded

user
string

The username to attach the uploaded file to

metadata
string

Metadata to be included in the callback event

delete-speaker-change
boolean

Automatically split paragraphs based on change of speaker

Headers

api-key
string
required

API key authorization (required if using header parameters)

content-type
string
required

MIME type of the file being uploaded

language
string

Language to transcribe

filename
string

The name of the file being uploaded

user
string

The username to attach the uploaded file to

metadata
string

Metadata to be included in the callback event

detect-speaker-change
boolean

Automatically split paragraphs based on change of speaker

 

Language options

The following language codes can be sent as a parameter:

Language Code
Language

en-GB

English (British)

en-US

English (North American)

en-AU

English (Australian)

en

English (All accents)

es

Spanish (European)

de

German

da

Danish

nl

Dutch

fi

Finnish

fr

French

hu

Hungarian

it

Italian

pl

Polish

pt

Portugese

ro

Romanian

ru

Russian

sv

Swedish

Suggest Edits

/srt/{trintId}

Generates an SRT file for the provided Trint id.

 
posthttps://api.trint.com/export/srt/trintId

Path Params

trintId
string
required

Id. of the Trint to export

Query Params

api-key
string

API key authorization (required if using query parameters)

Body Params

exportAsParagraphs
boolean

Creates caption per paragraph in editor instead of automating caption lengths (ignores exportSubtitleLength)

exportSubtitleLength
int32

Sets maximum character count before breaking to new line or caption. Also calculates maximum time before breaking into new caption (49ms/character), and minimum time before caption is allowed to break if in same paragraph (21ms/character).

exportHighlights
boolean

Creates captions for highlighted text only, and removes time in between (to align with EDL exports)

exportDisplaySpeakers
boolean

Appends associated speaker name to each caption

exportSpeakerPositionTop
boolean

If exportDisplaySpeakers is set to true, it sets the position of speaker names from inline to new line

exportUpperCaseSpeakers
boolean

Sets all speaker names to upper case

exportSkipStrikethroughs
boolean

Skips strikethroughs (can be applied to any export format)

Headers

api-key
string

API key authorization (required if using header parameters)

 

Generates an SRT file for the provided Trint id.

Returns the URL where the SRT file can be downloaded.

Suggest Edits

/webvtt/{trintId}

Generates a WebVTT file for the provided Trint id.

 
posthttps://api.trint.com/export/webvtt/trintId

Path Params

trintId
string
required

Id. of the Trint to export

Query Params

api-key
string

API key authorization (required if using query parameters)

Body Params

exportAsParagraphs
boolean

Creates caption per paragraph in editor instead of automating caption lengths (ignores exportSubtitleLength)

exportSubtitleLength
int32

Sets maximum character count before breaking to new line or caption. Also calculates maximum time before breaking into new caption (49ms/character), and minimum time before caption is allowed to break if in same paragraph (21ms/character).

exportHighlights
boolean

Creates captions for highlighted text only, and removes time in between (to align with EDL exports)

exportDisplaySpeakers
boolean

Appends associated speaker name to each caption

exportSpeakerPositionTop
boolean

If exportDisplaySpeakers is set to true, it sets the position of speaker names from inline to new line

exportUpperCaseSpeakers
boolean

Sets all speaker names to upper case

exportSkipStrikethroughs
boolean

Skips strikethroughs (can be applied to any export format)

Headers

api-key
string

API key authorization (required if using header parameters)

 

Generates a WebVTT file for the provided Trint id.

Returns the URL where the WebVTT file can be downloaded.

Suggest Edits

/edl/{trintId}

Generates an EDL file from the highlights of the provided Trint id.

 
posthttps://api.trint.com/export/edl/trintId

Path Params

trintId
string
required

Id. of the Trint to export

Query Params

api-key
string

API key authorization (required if using query parameters)

Body Params

exportSkipStrikethroughs
boolean

Skips struck through word times when creating timecodes if parameter is set to true

Headers

api-key
string

API key authorization (required if using header parameters)

 

Generates an EDL file from the highlights of the provided Trint id.

Returns the URL where the EDL file can be downloaded.

Suggest Edits

/docx/{trintId}

Generates a Microsoft Word document from the provided Trint id.

 
posthttps://api.trint.com/export/docx/trintId

Path Params

trintId
string
required

Id. of the Trint to export

Query Params

api-key
string

API key authorization (required if using query parameters)

Body Params

highlights
boolean

If true, only the highlights from the Trint

showTC
boolean

If true, the exported document will include timecodes on each paragraph

Headers

api-key
string

API key authorization (required if using header parameters)

 

Generates a Microsoft Word document from the provided Trint id.

Returns the URL where the document can be downloaded.

Suggest Edits

/xml/{trintId}

Generates an XML file from the provided Trint id.

 
posthttps://api.trint.com/export/xml/trintId

Path Params

trintId
string
required

Id. of the Trint to export

Query Params

api-key
string

API key authorization (required if using query parameters)

Headers

api-key
string

API key authorization (required if using header parameters)

 

Generates an XML file from the provided Trint id.

Returns the URL where the XML file can be downloaded.

The format of the XML is as follows:

<?xml version="1.0" encoding="UTF-8"?>
<Transcript>
Lorem ipsum dolor sit amet, consectetur adipiscing elit. 
</Transcript>
Suggest Edits

/json/{trintId}

Generates a JSON representation of the provided Trint ID

 
posthttps://api.trint.com/export/json/trintId

Path Params

trintId
string
required

Id. of the Trint to export

Query Params

api-key
string

API key authorization (required if using query parameters)

Headers

api-key
string

API key authorization (required if using header parameters)

 

Returns a JSON representation of a Trint.

The response will to fields: speakers and words

Speakers is a key-value pair mapping of speakerIds to Speaker objects. If not speakers have been assigned in the Trint editor this field will be an empty object.
Words is an array of Word objects

Speaker

Field
Type
Description
Mandatory / Optional

name

String

The speaker name as assigned in the Trint editor

Mandatory

Word

Field
Type
Description
Mandatory / Optional

duration

Int

The duration of the word in milliseconds

Mandatory

time

Int

The start time of the word in milliseconds.

Mandatory

paragraphId

String

The id of the paragraph containing the word.

Mandatory

value

String

The value of the word itself.

Mandatory

speaker

String

The id of the speaker

Optional

highlightColor

String

The highlight color assigned in the Trint editor

Optional

strikethrough

Boolean

True if the word has been struck through in the Trint editor

Optional

Suggest Edits

TRANSCRIPT_COMPLETE

 

Dispatched when an upload file finishes transcribing.

Payload

{ 
  eventType: 'TRANSCRIPT_COMPLETE',
  transcriptId: '<TRINT_ID>',
  title: 'myFile.mp4',
  user: 'tech@trint.com',
  metadata: 'some opaque metadata string' 
}
Parameters
Type
Description

eventType

String

Event type of the callback

transcriptId

String

The ID of the Trint that has completed transcribing

title

String

Title of the Trint

user

String

Username of the user attached to the Trint

metadata

String

If metadata was supplied at the time of upload then it will be reflected back here.

Suggest Edits

/

The Transcripts API allows operations to be performed on a user's transcripts.

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

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

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

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

url = URI("https://api.trint.com/transcripts")

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.trint.com/transcripts");

xhr.send(data);
import requests

url = "https://api.trint.com/transcripts"

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

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Query Params

limit
int32

Maximum number of transcripts to return

skip
int32

Number of transcripts to skip before returning