Application programming interface

This is an api to transcribe

• Multipart audio files: .wav .mp3 .mp4 .m4a .ogg .oga .wma
• Multipart vidoe files: .m4p .mkv .mov
• Yandex Disk and Google Drive folders or files
• URL direct links to files
• URL links to Youtube and VK.video

Base URL

The base URL for all API requests is: https://api.infercom.one/

Endpoints

POST /get-token

Returns security token

Request Body

Required input a JSON object with the following properties:

• username: String username
• password: String password

Response

Returns a JSON object with the following properties:

• access_token: The total number of books in the library
• status: String success
• id(optional): Int The unique user identifier
• username(optional): String username
• authority(optional): String Authority level
• confirmed(optional): Boolean

Example

Request:

curl -X POST -H "Content-Type: application/json" -d
'{"username":"admin","password":"admin"}' <https://infercom.one/api/get-
token>

Response:

{
    "access_token": "abc",
    "status": "success",
    "id": 1,
    "username": "admin",
    "authority": "USER",
    "confirmed": true
}

POST /transcribe/start-job

Initiate transcription job with URL link and receive job hash in return

Parameters

access_token: String security token

Request Body

Returns a JSON object with the following properties:

• user_id_internal: String of the user id
• task: String value “transcription”
• file: String URL link
• enforceTo: String “null” - any language of the audio, “en” - native translate to English any language, “ru” - native translate to Russian any language.

Response

Returns a JSON object with the following properties:

• hash: The total number of books in the library
• status: String success

Example

Request:

curl -X POST -H "Content-Type: application/json" -d 
'{"user_id":"3","file":"https://example.com/
test.mp3","task":"transcription"}' https://infercom.one/api/transcribe/start-
job?access_token=abc-xyz

Request:

{
    "hash": "qwerty12345",
    "status": "OK"
}

GET/transcribe/get-results

Get results given job hash if any.

Parameters

• type: String must be value transcription
• user_id: Integer
• hash: Hash of the job
• access_token: String security token

Response

• transcription: String with transcription or empty string
• status: String with status OK or processing

Example

Request:

curl -X GET https://infercom.one/api/transcribe/get-results?access_token=abc-
xyz&type=transcription&user_id=1&hash=qwerty12345

Request:

{
    "transcription": "abc xyz",
    "status": "OK"
}

Errors

This API uses the following error codes:

• 400 Bad Request: The request was malformed or missing required parameters
• 401 Unauthorized: The API key provided was invalid or missing
• 404 Not Found: The requested resource was not found
• 500 Internal Server Error: An unexpected error occurred on the server.