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://infercom.one/api/

Endpoints

POST /get-token

Register or login and returns security token

Parameters

header Content-Type: application/json

header Accept: application/json

Request Body

Required input a JSON object with the following properties:

• email: your@email.com
• 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: Int The unique user identifier
• email: String email
• authority: String Authority level
• confirmed: Boolean. If false, then you should confirm the email address.

Example

Request:

curl -X POST 
-H "Content-Type: application/json" 
-H "Accept: application/json"
-d '{"email":"your@email.com","password":"admin"}' 
"https://infercom.one/api/get-token"
						

Response:

{
    "access_token": "kNxYMn6J3LyWW092Jg16d3sab7RWiqcG",
    "status": "SUCCESS",
    "id": 1,
    "email": "your@email.com",
    "authority": "USER",
    "confirmed": true
}

POST /transcribe/start-job

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

Parameters

header Authorization: Bearer access_token

header Content-Type: application/json

header Accept: application/json

Request Body

Returns a JSON object with the following properties:

• user_id_internal(optional): String of the user id
• task: String value “transcription” or "scenario"
• file: String URL link
• enforceTo(optional): String “null” - any language of the audio, “en” - native translate to English any language. Default: “null“
• scenario_id(required if task = "scenario"): Int: id from https://infercom.one/api/scenarios

Response

Returns a JSON object with the following properties:

• hash: The total number of books in the library
• status: String in_progress / completed / failed

Example

Request:

curl -X POST 
-H "Content-Type: application/json"
-H "Authorization: Bearer abc" 
-H "Accept: application/json"
-d '{
"file":"https://example.com/test.mp3",
"task":"transcription"
}' "https://infercom.one/api/transcribe/start-job"

Response:

{
    "hash": "66432493b7e74",
    "status": "in_progress"
}

GET/transcribe/get-result

Get results given job hash if any.

Parameters

header Authorization: Bearer access_token

header Content-Type: application/json

header Accept: application/json

hash: Hash of the job

Response

• result: String with transcription or empty string
• status: String in_progress / completed / failed

Example

Request:

curl -X GET
-H "Content-Type: application/json"
-H "Authorization: Bearer abc" 
-H "Accept: application/json"
"https://infercom.one/api/transcribe/get-result?hash=hash"

Response:

{
    "result": "abc xyz\ntest",
    "status": "completed"
}

GET/scenario

Get available scenarios for data analysis.

Parameters

header Authorization: Bearer access_token

header Content-Type: application/json

header Accept: application/json

Response

• name: String scenario name
• value: Int Scenario id
• description(optional): String Scenario description
• button_text(optional): String The text on the button
• icon(optional): String Icon link

Example

Request:

curl -X GET
-H "Content-Type: application/json"
-H "Authorization: Bearer abc" 
-H "Accept: application/json"
"https://infercom.one/api/scenario"

Response:

{
    "name": "abc xdc",
    "value": 1",
    "description": "avvv acd",
    "button_text": "button_text",
    "icon": "link"
}

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
• 422 Validation Error: The request validation error
• 500 Internal Server Error: An unexpected error occurred on the server.