REST API

Obtain an Access-Token

GET https://zeroth.goodatlas.com:2053/token

Obtain an access-token to use the WebSocket endpoint.

Headers

Name	Type	Description
Authorization	string	appId:appSecret

200 The access_token can be used to open a WebSocket connection within the expires_in time.

{"access_token":"abcd","token_type":"Bearer","expires_in":600}

400

403 When no Authorization header or invalid credentials were provided.

Send URL of an audio file

POST https://zeroth.goodatlas.com:2053/transcripts

Send a JSON request that contains a URL of an audio file.

Headers

Name	Type	Description
Authorization	string	appId:appSecret

Request Body

Name	Type	Description
language	string	The language of the audio. eng or kor
audioUrl	string	URL of the audio file

200 The id can be used to fetch the result.

// when transcription is done
{"id":1309,"status":"done","transcript":"HELLO WORLD FROM ZEROTH CLOUD."}
// when transcription is still in progress
{"id":1309,"status":"queued","transcript":""}
// when transcription failed with error
{"id":1309,"status":"error","transcript":""}

400

403 When no Authorization header or invalid credentials were provided.

Get the result of a transcription

GET https://zeroth.goodatlas.com:2053/transcripts/{id}

Get the result of a transcription. The id will be response of the corresponding POST request

Path Parameters

Name	Type	Description
id	number	The id of the transcript

Headers

Name	Type	Description
Authorization	string	appId:appSecret

200

// when transcription is done
{"id":1309,"status":"done","transcript":"HELLO WORLD FROM ZEROTH CLOUD."}
// when transcription is still in progress
{"id":1309,"status":"queued","transcript":""}
// when transcription failed with error
{"id":1309,"status":"error","transcript":""}

400 If no transcript with the given Id exist.

403 When no Authorization header or invalid credentials were provided.