API Reference

Inference (GPU)

Default

/v1/health

GET /v1/health

서버의 Live 상태를 확인합니다.

Parameters

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline

/v1/info/server

GET /v1/info/server

서버의 기본적인 버전 정보들을 확인합니다.

Parameters

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline

/v1/info/model

GET /v1/info/model

서비스중인 추론모델의 이름을 식별합니다.

Parameters

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline

/v1/info/model/{model_name}

GET /v1/info/model/{model_name}

지정한 추론모델의 구성정보를 확인합니다.

Parameters

Name	In	Type	Required	Description
model_name	path	string	true	none

Parameters

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Face Identification

/v1/detect

POST /v1/detect

단일 이미지에서 다수 사용자 얼굴을 탐지합니다. (얼굴영역, 랜드마크)

Body Parameter

{
  "seq": 0,
  "maxResults": 750,
  "detectSortType": 0,
  "image": "string"
}

Parameters

Name	In	Type	Required	Description
x-api-key	header	string	true	none
body	body	DetectReqBody	true	none

200 Response

{
  "seq": 0,
  "faces": []
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	DetectResponse
422	Unprocessable Entity	Validation Error	HTTPValidationError

/v1/feature

POST /v1/feature

단일 이미지에서 단일 사용자의 얼굴 특징점을 추출합니다.

Body Parameter

{
  "image": "string"
}

Parameters

Name	In	Type	Required	Description
x-api-key	header	string	true	none
body	body	FeatureReqBody	true	none

200 Response

{
  "version": "1.10.3",
  "feature": "",
  "face_detect": {
    "processed": true,
    "confidence": 0,
    "boundingBox": {
      "left": 0,
      "top": 0,
      "right": 0,
      "bottom": 0
    },
    "landmarks": [
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	FeatureResponse
422	Unprocessable Entity	Validation Error	HTTPValidationError

/v1/feature_only

POST /v1/feature-only

전처리된 단일 이미지 (Aligned 112x112) 에서 단일 사용자의 얼굴 특징점을 추출합니다.

Body Parameter

{
  "image": "string"
}

Parameters

Name	In	Type	Required	Description
x-api-key	header	string	true	none
body	body	FeatureReqBody	true	none

200 Response

{
  "version": "1.10.3",
  "feature": "",
  "face_detect": {
    "processed": true,
    "confidence": 0,
    "boundingBox": {
      "left": 0,
      "top": 0,
      "right": 0,
      "bottom": 0
    },
    "landmarks": [
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	FeatureResponse
422	Unprocessable Entity	Validation Error	HTTPValidationError

/v1/multi_feature

POST /v1/multi-feature

단일 이미지에서 다수 사용자의 얼굴 특징점들을 추출합니다.

Body Parameter

{
  "image": "string",
  "maxResults": 128
}

Parameters

Name	In	Type	Required	Description
x-api-key	header	string	true	none
body	body	MultiFeatureReqBody	true	none

200 Response

{
  "version": "1.10.3",
  "feature_info_list": []
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	MultiFeatureResponse
422	Unprocessable Entity	Validation Error	HTTPValidationError

/v1/embeddings

POST /v1/embeddings

단일 이미지에서 단일 사용자의 얼굴 특징점 배열을 추출합니다.

Body Parameter

{
  "image": "string"
}

Parameters

Name	In	Type	Required	Description
x-api-key	header	string	true	none
body	body	EmbeddingsReqBody	true	none

200 Response

{
  "version": "1.10.3",
  "embeddings": [],
  "face_detect": {
    "processed": true,
    "confidence": 0,
    "boundingBox": {
      "left": 0,
      "top": 0,
      "right": 0,
      "bottom": 0
    },
    "landmarks": [
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	EmbeddingsResponse
422	Unprocessable Entity	Validation Error	HTTPValidationError

/v1/embeddings_only

POST /v1/embeddings-only

전처리된 단일 이미지 (Aligned 112x112) 에서 단일 사용자의 얼굴 특징점 배열을 추출합니다.

Body Parameter

{
  "image": "string"
}

Parameters

Name	In	Type	Required	Description
x-api-key	header	string	true	none
body	body	EmbeddingsReqBody	true	none

200 Response

{
  "version": "1.10.3",
  "embeddings": [],
  "face_detect": {
    "processed": true,
    "confidence": 0,
    "boundingBox": {
      "left": 0,
      "top": 0,
      "right": 0,
      "bottom": 0
    },
    "landmarks": [
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	EmbeddingsResponse
422	Unprocessable Entity	Validation Error	HTTPValidationError

/v1/multi_embeddings

POST /v1/multi-embeddings

단일 이미지에서 다수 사용자의 얼굴 특징점 배열들을 추출합니다.

Body Parameter

{
  "image": "string",
  "maxResults": 128
}

Parameters

Name	In	Type	Required	Description
x-api-key	header	string	true	none
body	body	MultiEmbeddingsReqBody	true	none

200 Response

{
  "version": "1.10.3",
  "embeddings_info_list": []
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	MultiEmbeddingsResponse
422	Unprocessable Entity	Validation Error	HTTPValidationError

/v1/score

POST /v1/score

2개의 이미지로부터, 각각 포함되어 있는 얼굴간의 유사도를 측정합니다.

Body Parameter

{
  "image1": "string",
  "image2": "string"
}

Parameters

Name	In	Type	Required	Description
x-api-key	header	string	true	none
body	body	ScoreReqBody	true	none

200 Response

{
  "score": 0,
  "face_detects": []
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	ScoreResponse
422	Unprocessable Entity	Validation Error	HTTPValidationError

/v1/feature-score

POST /v1/feature-score

2개의 특징점간의 유사도를 측정합니다.

Body Parameter

{
  "feature1": "string",
  "feature2": "string"
}

Parameters

Name	In	Type	Required	Description
x-api-key	header	string	true	none
body	body	FeatureScoreReqBody	true	none

200 Response

{
  "score": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	FeatureScoreResponse
422	Unprocessable Entity	Validation Error	HTTPValidationError

/v1/file/detect

POST /v1/file/detect

단일 이미지 파일에서 다수 사용자 얼굴을 탐지합니다. (얼굴영역, 랜드마크)

Body Parameter

seq: 0
maxResults: 750
detectSortType: 0
image: string

Parameters

Name	In	Type	Required	Description
x-api-key	header	string	true	none
body	body	Body_file_detect_v1_file_detect_post	true	none

200 Response

{
  "seq": 0,
  "faces": []
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	DetectResponse
422	Unprocessable Entity	Validation Error	HTTPValidationError

/v1/file/feature

POST /v1/file/feature

단일 이미지 파일에서 단일 사용자의 얼굴 특징점을 추출합니다.

Body Parameter

image: string

Parameters

Name	In	Type	Required	Description
x-api-key	header	string	true	none
body	body	Body_file_feature_v1_file_feature_post	true	none

200 Response

{
  "version": "1.10.3",
  "feature": "",
  "face_detect": {
    "processed": true,
    "confidence": 0,
    "boundingBox": {
      "left": 0,
      "top": 0,
      "right": 0,
      "bottom": 0
    },
    "landmarks": [
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	FeatureResponse
422	Unprocessable Entity	Validation Error	HTTPValidationError

/v1/file/feature-only

POST /v1/file/feature-only

전처리된 단일 이미지 (Aligned 112x112) 파일에서 단일 사용자의 얼굴 특징점을 추출합니다.

Body Parameter

image: string

Parameters

Name	In	Type	Required	Description
x-api-key	header	string	true	none
body	body	Body_file_feature_only_v1_file_feature_only_post	true	none

200 Response

{
  "version": "1.10.3",
  "feature": "",
  "face_detect": {
    "processed": true,
    "confidence": 0,
    "boundingBox": {
      "left": 0,
      "top": 0,
      "right": 0,
      "bottom": 0
    },
    "landmarks": [
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	FeatureResponse
422	Unprocessable Entity	Validation Error	HTTPValidationError

/v1/file/embeddings

POST /v1/file/embeddings

단일 이미지 파일에서 단일 사용자의 얼굴 특징점 배열을 추출합니다.

Body Parameter

image: string

Parameters

Name	In	Type	Required	Description
x-api-key	header	string	true	none
body	body	Body_file_embeddings_v1_file_embeddings_post	true	none

200 Response

{
  "version": "1.10.3",
  "embeddings": [],
  "face_detect": {
    "processed": true,
    "confidence": 0,
    "boundingBox": {
      "left": 0,
      "top": 0,
      "right": 0,
      "bottom": 0
    },
    "landmarks": [
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	EmbeddingsResponse
422	Unprocessable Entity	Validation Error	HTTPValidationError

/v1/file/embeddings-only

POST /v1/file/embeddings-only

전처리된 단일 이미지 (Aligned 112x112) 파일에서 단일 사용자의 얼굴 특징점 배열을 추출합니다.

Body Parameter

image: string

Parameters

Name	In	Type	Required	Description
x-api-key	header	string	true	none
body	body	Body_file_embeddings_only_v1_file_embeddings_only_post	true	none

200 Response

{
  "version": "1.10.3",
  "embeddings": [],
  "face_detect": {
    "processed": true,
    "confidence": 0,
    "boundingBox": {
      "left": 0,
      "top": 0,
      "right": 0,
      "bottom": 0
    },
    "landmarks": [
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      }
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	EmbeddingsResponse
422	Unprocessable Entity	Validation Error	HTTPValidationError

/v1/file/score

POST /v1/file/score

2개의 이미지 파일로부터, 각각 포함되어 있는 얼굴간의 유사도를 측정합니다.

Body Parameter

image1: string
image2: string

Parameters

Name	In	Type	Required	Description
x-api-key	header	string	true	none
body	body	Body_file_score_v1_file_score_post	true	none

200 Response

{
  "score": 0,
  "face_detects": []
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	ScoreResponse
422	Unprocessable Entity	Validation Error	HTTPValidationError

Schemas

/v1/file/detect body

{
  "seq": 0,
  "maxResults": 750,
  "detectSortType": 0,
  "image": "string"
}

Name	Type	Required	Restrictions	Description
seq	integer	false	none	none
maxResults	integer	false	none	none
detectSortType	integer	false	none	none
image	string(binary)	true	none	none

/v1/file/embeddings-only body

{
  "image": "string"
}

Name	Type	Required	Restrictions	Description
image	string(binary)	true	none	none

/v1/file/embeddings

{
  "image": "string"
}

Name	Type	Required	Restrictions	Description
image	string(binary)	true	none	none

/v1/file/feature-only body

{
  "image": "string"
}

Name	Type	Required	Restrictions	Description
image	string(binary)	true	none	none

/v1/file/feature

{
  "image": "string"
}

Name	Type	Required	Restrictions	Description
image	string(binary)	true	none	none

/v1/file/score

{
  "image1": "string",
  "image2": "string"
}

Name	Type	Required	Restrictions	Description
image1	string(binary)	true	none	none
image2	string(binary)	true	none	none

BoundingBox

{
  "left": 0,
  "top": 0,
  "right": 0,
  "bottom": 0
}

Name	Type	Required	Restrictions	Description
left	integer	false	none	none
top	integer	false	none	none
right	integer	false	none	none
bottom	integer	false	none	none

DetectReqBody

{
  "seq": 0,
  "maxResults": 750,
  "detectSortType": 0,
  "image": "string"
}

Name	Type	Required	Restrictions	Description
seq	integer	false	none	reserved
maxResults	integer	false	none	none
detectSortType	integer	false	none	none
image	string	true	none	base64 encoded data

DetectResponse

{
  "seq": 0,
  "faces": []
}

Name	Type	Required	Restrictions	Description
seq	integer	false	none	none
faces	[DetectResult]	false	none	none

DetectResult

{
  "processed": true,
  "confidence": 0,
  "boundingBox": {
    "left": 0,
    "top": 0,
    "right": 0,
    "bottom": 0
  },
  "landmarks": [
    {
      "x": 0,
      "y": 0
    },
    {
      "x": 0,
      "y": 0
    },
    {
      "x": 0,
      "y": 0
    },
    {
      "x": 0,
      "y": 0
    },
    {
      "x": 0,
      "y": 0
    }
  ]
}

Name	Type	Required	Restrictions	Description
processed	boolean	false	none	none
confidence	number	false	none	none
boundingBox	BoundingBox	false	none	none
landmarks	[Landmark]	false	none	none

EmbeddingsInfoResult

{
  "embeddings": [],
  "face_detect": {
    "processed": true,
    "confidence": 0,
    "boundingBox": {
      "left": 0,
      "top": 0,
      "right": 0,
      "bottom": 0
    },
    "landmarks": [
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      }
    ]
  }
}

Name	Type	Required	Restrictions	Description
embeddings	[number]	false	none	none
face_detect	DetectResult	false	none	none

EmbeddingsReqBody

{
  "image": "string"
}

Name	Type	Required	Restrictions	Description
image	string	true	none	base64 encoded data

EmbeddingsResponse

{
  "version": "1.10.3",
  "embeddings": [],
  "face_detect": {
    "processed": true,
    "confidence": 0,
    "boundingBox": {
      "left": 0,
      "top": 0,
      "right": 0,
      "bottom": 0
    },
    "landmarks": [
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      }
    ]
  }
}

Name	Type	Required	Restrictions	Description
version	string	false	none	none
embeddings	[number]	false	none	none
face_detect	DetectResult	false	none	none

FeatureInfoResult

{
  "feature": "",
  "face_detect": {
    "processed": true,
    "confidence": 0,
    "boundingBox": {
      "left": 0,
      "top": 0,
      "right": 0,
      "bottom": 0
    },
    "landmarks": [
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      }
    ]
  }
}

Name	Type	Required	Restrictions	Description
feature	string	false	none	none
face_detect	DetectResult	false	none	none

FeatureReqBody

{
  "image": "string"
}

Name	Type	Required	Restrictions	Description
image	string	true	none	base64 encoded data

FeatureResponse

{
  "version": "1.10.3",
  "feature": "",
  "face_detect": {
    "processed": true,
    "confidence": 0,
    "boundingBox": {
      "left": 0,
      "top": 0,
      "right": 0,
      "bottom": 0
    },
    "landmarks": [
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      },
      {
        "x": 0,
        "y": 0
      }
    ]
  }
}

Name	Type	Required	Restrictions	Description
version	string	false	none	none
feature	string	false	none	none
face_detect	DetectResult	false	none	none

FeatureScoreReqBody

{
  "feature1": "string",
  "feature2": "string"
}

Name	Type	Required	Restrictions	Description
feature1	string	true	none	base64 encoded data
feature2	string	true	none	base64 encoded data

FeatureScoreResponse

{
  "score": 0
}

Name	Type	Required	Restrictions	Description
score	number	false	none	none

HTTPValidationError

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Name	Type	Required	Restrictions	Description
detail	[ValidationError]	false	none	none

Landmark

{
  "x": 0,
  "y": 0
}

Name	Type	Required	Restrictions	Description
x	integer	false	none	none
y	integer	false	none	none

MultiEmbeddingsReqBody

{
  "image": "string",
  "maxResults": 128
}

Name	Type	Required	Restrictions	Description
image	string	true	none	base64 encoded data
maxResults	integer	false	none	none

MultiEmbeddingsResponse

{
  "version": "1.10.3",
  "embeddings_info_list": []
}

Name	Type	Required	Restrictions	Description
version	string	false	none	none
embeddings_info_list	[EmbeddingsInfoResult]	false	none	none

MultiFeatureReqBody

{
  "image": "string",
  "maxResults": 128
}

Name	Type	Required	Restrictions	Description
image	string	true	none	base64 encoded data
maxResults	integer	false	none	none

MultiFeatureResponse

{
  "version": "1.10.3",
  "feature_info_list": []
}

Name	Type	Required	Restrictions	Description
version	string	false	none	none
feature_info_list	[FeatureInfoResult]	false	none	none

ScoreReqBody

{
  "image1": "string",
  "image2": "string"
}

Name	Type	Required	Restrictions	Description
image1	string	true	none	base64 encoded data
image2	string	true	none	base64 encoded data

ScoreResponse

{
  "score": 0,
  "face_detects": []
}

Name	Type	Required	Restrictions	Description
score	number	false	none	none
face_detects	[DetectResult]	false	none	none

ValidationError

{
  "loc": [
    "string"
  ],
  "msg": "string",
  "type": "string"
}

Name	Type	Required	Restrictions	Description
loc	[anyOf]	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

or

Name	Type	Required	Restrictions	Description
» anonymous	integer	false	none	none

continued

Name	Type	Required	Restrictions	Description
msg	string	true	none	none
type	string	true	none	none