Public
Documentation Settings
No Environment
Double Column
cURL - cURL
오토피디아 ML API v1.0
Introduction
Version / Release
Authentication
Rate Limit
이미지 업로드 시 주의사항
ErrorCode
GET
/images
POST
/treads/r1/predict

오토피디아 ML API v1.0

본 페이지에서는 오토피디아에서 현재 제공 중인 머신러닝(ML) API들의 목록과 입출력 형태를 확인할 수 있습니다.

오토피디아에서는 다양한 차량 문제를 머신러닝 기술로 해결하기 위해 노력하고 있으며 현재 제공 중인 API에서 더 추가되었으면 하는 기능, 정보, 예측값이 있으시거나 본 페이지에는 명시되어 있지 않지만 추가로 더 필요한 API가 있으시다면 ml-api@autopediacar.com 으로 편하게 연락주시기 바랍니다.

AUTHORIZATIONAPI Key
Key

x-api-key

Value

<value>

Version / Release

  • Version : API 전반에 걸친 스펙 변경(인증 방식, 에러 코드 형식 변경 등)이 발생할 경우에는 버전이 변경됩니다. 서버 호출 시 BASE URL은https://ml-api.doctor-cha.com/{version}/ 의 형태이며 현재 버전은 v1 입니다.

  • Release : 각각의 분석 API들은 https://ml-api.doctor-cha.com/{version}/{model-name}/{release}/predict 와 같은 URI를 가지며 Version에 비해 상대적으로 빠르게 개발 및 업데이트 될 수 있습니다. 분석 API의 예측 정보가 추가되거나(예: 편마모 여부 정보 추가), 예측 형식이 변경되는 경우에는 Release가 올라갑니다.

    • 예: 타이어 마모도를 판단하는 API의 경우 현재 릴리즈는 r1 입니다.
AUTHORIZATIONAPI Key
This folder is using API Key from collection오토피디아 ML API v1.0

Authentication

  • 모든 API를 호출할 때에는 Header 상에 x-api-key : 을 추가하여야 합니다. 잘못된 API Key 값 혹은 API KEY 값이 존재하지 않을 시에는 403 Forbidden 에러가 발생합니다.
  • API KEY는 현재 ml-api@autopediacar.com 을 통해 API 사용 요청을 접수해주시면 발급해드리고 있습니다.
  • 해당 API KEY 값이 노출/유출될 경우 제 3자가 호출한 건수가 API KEY 소유주분께 집계될 수 있으니 소스코드 상에 노출이 되지 않도록 보안에 주의가 필요합니다.
AUTHORIZATIONAPI Key
This folder is using API Key from collection오토피디아 ML API v1.0

Rate Limit

  • 현재 본 페이지의 API들은 베타 상태이며 과도한 API 호출로 인한 서버 부하를 막기 위해 아래와 같은 Rate Limit을 가지고 있습니다.
  • Rate Limit은 개별 메소드 별로 적용되지 않으며 사용하신 API Key 값을 기준으로 메소드에 상관 없이 호출하신 모든 호출 건수가 기록됩니다.
    • 예: /images 메소드 200번 호출 + /treads/r1/predict 메소드 30번 호출 = 총 230번 호출
  • 초당 요율 : 10 requests/sec (Hard limit은 아니며 Soft limit입니다)
  • 월 할당량 : 10,000 requests/sec (Hard limit은 아니며 Soft limit입니다)
  • 상기 Rate Limit을 초과하는 호출이 발생할 경우 429 Too Many Request 에러가 발생합니다.
  • Rate Limit의 상향이 필요한 경우 ml-api@autopediacar.com 으로 문의주시기 바랍니다.
AUTHORIZATIONAPI Key
This folder is using API Key from collection오토피디아 ML API v1.0

이미지 업로드 시 주의사항

  • 모든 사진 분석 API를 호출하기 전에 /images EndPoint를 통해서 오토피디아의 S3 버킷에 추론용 이미지를 업로드(upload_url) 하고 다운로드(download_url) 할 수 있는 pre-signed URL을 발급 받아야 합니다. pre-signed URL은 1000초의 유효 기간을 가지므로 유효 기간이 지난 후에는 발급 받은 URL이 만료되며 업로드와 다운로드가 모두 불가능해집니다.
  • 사용자의 클라이언트 단에서 upload_url 경로에 이미지 파일을 PUT 메소드를 통해 업로드 해야 합니다.
  • 사용자의 클라이언트 단에서 이미지가 업로드 완료된 뒤에 사진 분석 API(예: /treads/r1/predict )에 download_url 파라미터를 전달하는 방식으로 추론 요청을 보낼 수 있습니다.
  • 추론 서버는 제공된 download_url 을 통해 오토피디아의 S3 버킷으로부터 이미지를 다시 다운 받은 후 학습된 딥러닝 모델에서 추론하게 됩니다.
  • 위와 같은 방식을 통해 API Gateway에 가해지는 네트워크 부하를 줄일 수 있으며 클라이언트 단에서는 업로드 중과 분석 중 상태를 직접 관리하게 되므로 대기 중인 사용자에게 각 상태 별로 안내 메시지를 표시하는 등의 응용이 가능합니다.
AUTHORIZATIONAPI Key
This folder is using API Key from collection오토피디아 ML API v1.0
Loading