Short Denoiser API

해당 문서는 DeepHearing Denoiser API에 관한 문서입니다.

Request

Denoiser API를 통해 사용자는 파일 기반의 노이즈 제거를 진행할 수 있습니다.

Method	URL
POST	https://apigw.prod.deephearing.com/denoise

파일은 요청 1회에 1개의 파일만 처리할 수 있습니다. 또한 파일 처리는 동기적으로 수행되며 오디오가 처리된 후 결과를 받습니다.

Header

먼저 API 요청을 보내기 전에 미리 제공받은 API 키를 header에 추가해야 합니다.

Header

var header = {
  'X-API-KEY': "<API_KEY>"
}

Body

파일 키와 함께 오디오 파일을 API에 POST 요청하면 노이즈 제거된 오디오 파일을 반환받습니다.

Body

formdata.append("audio", fileInput.files[0]);

주의

form-data에 오디오 파일을 추가할 때 Key는 "audio"로 설정해주셔야합니다.

Supports

지원하는 파일 확장자는 다음과 같습니다.

Type	Description
.wav	API 기본 설정입니다.	recommended
.mp3	mp3 파일을 처리할 때 query로 encoding type을 지정해주어야 합니다.

정보

mp3 파일에 대해 처리하는 방법은 아래와 같습니다.

Example

var audioFile = fileInput.files[0];

fetch("https://apigw.staging.deephearing.com/denoise?encoding=mp3", 
  { 
    // options...
  })
  .then(response => {
    // other actions...
  })
  .then(result => console.log(result))
  .catch(error => console.error(error));

주의

wav의 경우 기본 설정이므로 query에 encoding을 추가하지 않아도 API가 작동하지만 mp3의 경우 query로 encoding을 추가해야 API를 사용할 수 있습니다.

노트

wav의 경우 ?encoding=wav를 추가해서도 API를 사용하실 수 있습니다.

Request Sample

curl

curl --location 'https://apigw.staging.deephearing.com/denoise' \
     --form 'audio=@"/path/to/file"'

Sample Code

var fileInput = document.querySelector("input[name=audio]")

var headers = new Headers();
headers.append("X-API-KEY", "<API_KEY>");

var formdata = new FormData();
formdata.append("audio", fileInput.files[0]); //formdata키는 audio로 설정해야합니다.

var options = {
  method: 'POST',
  headers,
  body: formdata,
};

//이 경우 wav 파일에 대해서만 정상작동
fetch("https://apigw.staging.deephearing.com/denoise", options)
  .then(response => {
    // other actions...
  })
  .then(result => console.log(result))
  .catch(error => console.error(error));

Responses

Success Response

Success

{
  "result": "<Base64로 인코딩된 오디오 파일>",
  "totalBilledTime": "<오디오 파일의 총 길이>",
  "usageRemain": "<남은 사용량>"
}

Error Response

403

{
  message: "Forbidden"
}

413

{
  message: "Request Too Long"
}

500

{
  message: "Internal server error"
}