Aditu files API

URL

https://api.aditu.eus

Methods

Transcribe a file. It can be either an audio file (.wav, .mp3) or a video file (.mp4, .webm). Only POST method is allowed.

Request example 

{ 
	"api_id" : "<YOUR_API_ID>",
	"api_key" : "<YOUR_API_KEY>",
	"language" : "eu" | "es" | "eu-es",
	"channel" : 0 (left) | 1 (right) | 2 (stereo, default),
	"file" : <YOUR_FILE>,
	"bilingual_all" (optional): "yes" | "no",
	"allow_edit" (optional): "yes" | "no"
}
Response example 

{ 
	"task_id" : "6dc0ce4d-08c5-4754-8ecc-5385e489684e",
}

Check transcription progress of a given task. Only POST method is allowed.

Request example 

{ 
	"api_id" : "<YOUR_API_ID>",
	"api_key" : "<YOUR_API_KEY>",
	"task_id" : "6dc0ce4d-08c5-4754-8ecc-5385e489684e"
}
Response example Task is running 

{
    "finished": False,
    "error": False,
    "percentage": "75",
    "message": "Running transcription", # Just an example
}
Task finished with errors. 

{
	"finished": True,
	"error": True,
	"message": "There was an error", # Just an example
}
Task finished without errors. 

{
	"finished": True,
	"error": False,
	"original_file": "<POSTED_FILE_URL>",
	"json": "<JSON_FILE>", # .json
	"trascription": "<TRANSCRIPTION_FILE>", # .txt
	"subtitles": "<SUBTITLES_FILE>", # .srt
	"execution_time": "67.25", #Time to transcribe file in seconds
	"file_id": "653", #If allow_edit was passed, this is the file_id to
					   go to the web interface for editing
					   and afterwards retrieving the corrected subtitles
}

Check user time information. Only POST method is allowed.

Request example 

{ 
	"api_id" : "<YOUR_API_ID>",
	"api_key" : "<YOUR_API_KEY>"
	"type" : "monolingual" | "bilingual" | "translation",
}
Response example 

{
    "user_time": 36000, # in seconds, 10 hours
    "used_time": 3600 # 1 hour
}

Check user server space information. Only POST method is allowed.

Request example 

{ 
	"api_id" : "<YOUR_API_ID>",
	"api_key" : "<YOUR_API_KEY>"
}
Response example 

{
    "server_space": 5368709120, # in bytes, 5GB
    "used_server_space": 2254857830 # 2.1GB
}

URL

https://aditu.eus

Methods

Retrieves words JSON file after edited in interface. Only POST method is allowed.

Request example 

{
	"api_id" : "<YOUR_API_ID>",
	"api_key" : "<YOUR_API_KEY>",
	"file_id" : "653"
}
Response example JSON file with word times

Retrieves transcription text file after edited in interface. Only POST method is allowed.

Request example 

{
	"api_id" : "<YOUR_API_ID>",
	"api_key" : "<YOUR_API_KEY>",
	"file_id" : "653"
}
Response example Text file with transcription

Retrieves SRT subtitles file after edited in interface. Only POST method is allowed.

Request example 

{
	"api_id" : "<YOUR_API_ID>",
	"api_key" : "<YOUR_API_KEY>",
	"file_id" : "653"
}
Response example SRT subtitles file

Retrieves VTT subtitles file after edited in interface. Only POST method is allowed.

Request example 

{
	"api_id" : "<YOUR_API_ID>",
	"api_key" : "<YOUR_API_KEY>",
	"file_id" : "653"
}
Response example VTT subtitles file

Deletes file after edited in interface. Only POST method is allowed.

Request example 

{
	"api_id" : "<YOUR_API_ID>",
	"api_key" : "<YOUR_API_KEY>",
	"file_id" : "653"
}
Response example {'status': 'OK'}

Client software example

Python

Python script that calls the API with the contents of an audio or video file and retrieves the results: https://api.aditu.eus/static/api_client.py.

Shell script

Shell script that calls the API with the contents of an audio or video file and retrieves the results: https://api.aditu.eus/static/api_client.sh.