API Reference

API KEY INSTRUCTIONS

Ensure that you include your API key in all requests by using the following format: curl -H "X-API-KEY: MYAPIKEY" https://api.mydomain.com/v1/users. Need an API key or instructions on how to obtain one?

Start a Transcription

This endpoint kicks off a transcription job. It returns a job ID that can be used to check the status of the transcription job.

HTTP Method and URL

POST https://api.classifai.tcu.edu/start_transcription

Parameters

Name	Type	Description	Required?
file	file	This is the audio file. It can be in mp3, wav, etc. FFMpeg supports many file types	Required
user_id	string	This is the user ID. It is used to identify the user that made the reqeust	Optional
model_type	string	Model Type. Can be "large", "medium", "medium.en", "tiny.en", more here	Optional

Example Request

Example Response

HTTP 200 OK

{
  "job_id": "a3a8ed6e-f538-4a06-8fd2-4a3f3ff906ee", 
  "model_type": "tiny.en",
  "status": "in progress", 
  "state": "loading model",
  "start_time": 1698877559.0479097,
  "duration": 0
}

Element	Type	Description
job_id	string	This is the job ID, generated using UUID. It can be used to check the status of the transcription job.
model_type	string	This is the model type. It can be "large", "medium", "medium.en", "tiny.en", more here
status	string	This is the status of the transcription job. It can be "in progress", "completed", or "error"
state	string	This is the state of the transcription job. It can be "loading model", "loading audio", "transcribing", "uploading", "completed", or "error"
start_time	float	This is the start time of the transcription job. It is a Unix timestamp.
duration	float	This is the duration of the transcription job. It is a Unix timestamp.

Error and Status Codes

Code	Message	Meaning
400	No file provided	The request did not include a file
400	Invalid file type	The file type is not supported
400	Invalid model type	The model type is not supported
400	Invalid user ID	The user ID is not valid
500	Internal Server Error	Something went wrong on our end. Please try again later.

Get Transcription

This endpoint returns the status of a transcription job. It can be used to check the status of a transcription job, or to get the transcription file.

HTTP Method and URL

GET https://api.classifai.tcu.edu/get_transcription

Parameters

[Table that lists all query and path parameters for the endpoint. If this endpoint has query and path parameters, consider listing them in separate tables---one for path parameters, one for query parameters. If there aren't any parameters for this endpoint, replace the table with "None"]

Name	Type	Description	Required?
job_id	string	This is the job ID. It can be used to check the status of the transcription job, or to get the transcription file.	Required

Example Request

Element	Type	Description	Required?
job_id	string	This is the job ID. It can be used to check the status of the transcription job, or to get the transcription file.	Required

Example Response

{
  "job_id": "a3a8ed6e-f538-4a06-8fd2-4a3f3ff906ee",
  "model_type": "tiny.en", 
  "status": "in progress", 
  "state": "loading model", 
  "start_time": 1698877559.0479097, 
  "duration": 22.8137366771698
}

Element	Type	Description
job_id	string	This is the job ID, generated using UUID. It can be used to check the status of the transcription job, or to get the transcription file.
model_type	string	This is the model type.
status	string	This is the status of the transcription job. It can be "in progress", "completed", "not found", or "error"
state	string	This is the state of the transcription job. It can be "loading model", "loading audio", "transcribing", "uploading", "completed", or "error"
start_time	float	This is the start time of the transcription job. It is a Unix timestamp.
duration	float	This is the duration of the transcription job. It is a Unix timestamp.
end_time	float	This is the end time of the transcription job (if it is completed). It is a Unix timestamp.
transcription_link	string	This is the link to the transcription file (if it is completed). It can be used to download the transcription file. Looking for the transcription format?

Error and Status Codes

Code	Message	Meaning
400	No job ID provided	The request did not include a job ID
404	Job not found	The job ID provided does not match any transcription jobs.
500	Internal Server Error	Something went wrong on our end. Please try again later.

[Remove an employee]

[The heading above should be a very brief description of what the endpoint does.]

HTTP Method and URL

[GET, PUT, POST, or DELETE and URL---for example, DELETE https://api.payrollrecord.com/employee/{employee_id}]

Parameters

[Table that lists all query and path parameters for the endpoint. If this endpoint has query and path parameters, consider listing them in separate tables---one for path parameters, one for query parameters. If there aren't any parameters for this endpoint, replace the table with "None"]

Name	Type	Description	Required?
[Name or parameter]	[Query or Path]	[Brief description of parameter function. What does it do?]	[Required or Optional]
[Name or parameter]	[Query or Path]	[Brief description of parameter function. What does it do?]	[Required or Optional]
[Name or parameter]	[Query or Path]	[Brief description of parameter function. What does it do?]	[Required or Optional]

Example Request

[Code or pseudocode sample of a complete request for this endpoint, including header and body, followed by a table that lists each element in the example request]

Element	Type	Description	Required?
[Element as it appears in request]	[Array, Object, String, Integer, or Float]	[Brief description of what information the element represents, including default and valid values]	[Required or Optional]
[Element as it appears in request]	[Array, Object, String, Integer, or Float]	[Brief description of what information the element represents, including default and valid values]	[Required or Optional]
[Element as it appears in request]	[Array, Object, String, Integer, or Float]	[Brief description of what information the element represents, including default and valid values]	[Required or Optional]

Example Response

[Code or pseudocode sample of a complete response for this endpoint, followed by a table that lists each element in the example response]

Element	Type	Description
`{"job_id": "a3a8ed6e-f538-4a06-8fd2-4a3f3ff906ee", "model_type": "tiny.en", "status": "in progress", "state": "loading
model", "start_time": 1698877559.0479097, "duration": 22.8137366771698}`	Object	[Brief description of what information the element represents]
`{"job_id": "a3a8ed6e-f538-4a06-8fd2-4a3f3ff906ee", "model_type": "tiny.en", "status": "in progress", "state": "loading
[Element as it appears in response]	[Array, Object, String, Integer, or Float]	[Brief description of what information the element represents]
[Element as it appears in response]	[Array, Object, String, Integer, or Float]	[Brief description of what information the element represents]
[Element as it appears in response]	[Array, Object, String, Integer, or Float]	[Brief description of what information the element represents]

Error and Status Codes

[Table that lists all possible error and status codes for this endpoint]

Code	Message	Meaning
[HTTP or error code]	[Message for the code, such as "Not Found"]	[Brief description of what the code means within your API, such as "We couldn't complete your request right now"]
[HTTP or error code]	[Message for the code, such as "Not Found"]	[Brief description of what the code means within your API, such as "We couldn't complete your request right now"]
[HTTP or error code]	[Message for the code, such as "Not Found"]	[Brief description of what the code means within your API, such as "We couldn't complete your request right now"]