# 이미지 유사도 비교 기준 이미지 한 장과 비교 이미지 여러 장을 올리면 비교 이미지마다 기준 이미지와 얼마나 비슷한지 0~1 점수로 돌려줍니다. 인증: Authorization: Bearer $APICK_API_KEY 본문 있는 REST 요청: multipart/form-data. GET 본문 및 MCP JSON-RPC 규격은 해당 명세를 따릅니다. 인증키는 서버에 보관하세요. 모든 예제는 정적 자료입니다. ## POST /rest/image_similarity 응답 필드 - `data` (object): 요청 처리 결과 묶음입니다. 조회한 값·작업 상태·오류 설명이 이 안에 들어 있으며, 실제 하위 필드 구성은 서비스마다 다릅니다. 값이 없으면 null·빈 배열·필드 생략 중 해당 서비스의 규칙을 따릅니다. - `data.output` (object): 처리 결과 값 묶음입니다. 서비스가 계산한 이미지 비교 값 등이 들어 있습니다. - `data.output.compare_image1` (number): 비교 대상 이미지와 기준 이미지의 유사도입니다. 1에 가까울수록 같고, 0에 가까울수록 다릅니다. - `data.output.compare_image2` (number): 비교 대상 이미지와 기준 이미지의 유사도입니다. 1에 가까울수록 같고, 0에 가까울수록 다릅니다. - `data.output.compare_image3` (number): 비교 대상 이미지와 기준 이미지의 유사도입니다. 1에 가까울수록 같고, 0에 가까울수록 다릅니다. - `data.success` (integer): 업무 처리 결과 코드입니다. 1은 정상 결과, 0은 실패 또는 무료 응답입니다. 서비스에 따라 2·3처럼 추가 코드를 쓰므로 같은 응답의 status·msg·error 필드도 함께 확인하세요. - `api` (object): API 호출 메타데이터입니다. 이번 요청의 서버 처리 성공 여부(api.success), 실제 차감 포인트(api.cost), 결제 기록 ID(api.pl_id)를 담습니다. 처리 시간(api.ms)은 응답에 포함된 경우에만 제공됩니다. 업무 결과는 data에서 확인합니다. - `api.success` (boolean): API 서버가 이번 요청을 정상 처리했는지 여부입니다. true여도 업무 결과가 실패일 수 있으므로 data.success·data.status와 함께 판단합니다. 인증 실패·잘못된 입력·서버 오류 응답에서는 false입니다. - `api.cost` (integer): 이번 호출에서 실제로 차감된 포인트입니다. 유료 성공 응답에서만 단가만큼 차감되며, 실패·무료 조회·같은 요청의 멱등 재전송은 0입니다. 화면의 표시 단가와 실제 차감액이 다를 수 있으므로 정산은 이 값을 기준으로 합니다. - `api.ms` (integer): 서버가 요청을 받아 응답 본문을 만들기까지 걸린 처리 시간(밀리초)입니다. 네트워크 왕복 시간과 클라이언트 대기 시간은 포함되지 않습니다. - `api.pl_id` (integer): 포인트 차감 기록 ID입니다. 차감이 발생한 호출에만 값이 있으며, 과금 내역을 문의할 때 이 번호를 사용합니다. 무과금 응답은 -1·null이거나 필드가 생략됩니다. ## API 요청: POST /rest/image_similarity ### 입력 - `image` (file, 필수): 분석할 이미지 파일입니다. JPG·PNG·WEBP를 지원하며, 파일 크기·해상도 제한은 요청 표를 확인하세요. - `compare_image1` (file, 필수): 첫 비교 이미지. 추가 이미지는 compare_image2, compare_image3처럼 1부터 연속 번호로 전달하며 최대 1,000개입니다. 번호가 빠지면 이후 이미지는 처리하지 않습니다. - `compare_image2` (file, 선택): 두 번째 비교 이미지입니다. 더 비교하려면 compare_image3, compare_image4 … 처럼 번호를 이어서 보냅니다(최대 1,000장). ### 응답 명세 ```json { "type": "object", "properties": { "data": { "type": "object", "properties": { "output": { "type": "object", "properties": { "compare_image1": { "type": "number" }, "compare_image2": { "type": "number" }, "compare_image3": { "type": "number" } }, "description": "비교 이미지 필드 이름(compare_image1, compare_image2 …)을 키로, 기준 이미지와의 유사도 0~1을 값으로 담은 객체입니다. 1에 가까울수록 비슷하며, 보낸 비교 이미지 수만큼 키가 있습니다.", "additionalProperties": { "type": "number", "description": "n번째 비교 이미지의 유사도 0~1입니다. 1에 가까울수록 비슷합니다." } }, "success": { "type": "integer", "description": "처리 결과입니다. 1: 성공(과금), 0: 실패, 3: 시간 초과(과금 없음)." } }, "description": "비교 결과" }, "api": { "type": "object", "properties": { "success": { "type": "boolean", "description": "요청을 정상 처리했는지 여부입니다." }, "cost": { "type": "integer", "description": "이번 요청에서 차감된 포인트입니다." }, "ms": { "type": "integer", "description": "처리 시간(밀리초)입니다." }, "pl_id": { "type": "integer", "description": "결제 기록 번호입니다. 문의할 때 함께 알려 주세요." } }, "description": "호출 공통 정보" } } } ``` ### 정적 응답 예시 ```json { "data": { "output": { "compare_image1": 0.8199545438545536, "compare_image2": 0.5330405783587735, "compare_image3": 0.9999999852726211 }, "success": 1 }, "api": { "success": true, "cost": 16, "ms": 1023, "pl_id": 1237778 } } ``` ### curl ```curl curl --fail-with-body --request POST 'https://apick.app/rest/image_similarity' \ --header "Authorization: Bearer $APICK_API_KEY" \ --form 'image=@./original.jpg' \ --form 'compare_image1=@./candidate1.jpg' \ --form 'compare_image2=@./candidate2.jpg' \ --form 'compare_image3=@./candidate3.jpg' ``` ### Node.js (서버 ESM) ```javascript import { readFile } from "node:fs/promises"; const form = new FormData(); form.append("image", new Blob([await readFile("./original.jpg")]), "original.jpg"); form.append("compare_image1", new Blob([await readFile("./candidate1.jpg")]), "candidate1.jpg"); form.append("compare_image2", new Blob([await readFile("./candidate2.jpg")]), "candidate2.jpg"); form.append("compare_image3", new Blob([await readFile("./candidate3.jpg")]), "candidate3.jpg"); const response = await fetch("https://apick.app/rest/image_similarity", { method: "POST", headers: { Authorization: "Bearer " + process.env.APICK_API_KEY }, body: form, signal: AbortSignal.timeout(120_000), }); if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`); const result = await response.json(); console.log(result); ``` ### python ```python import os import requests parts = [ ("image", ("original.jpg", open("./original.jpg", "rb"))), ("compare_image1", ("candidate1.jpg", open("./candidate1.jpg", "rb"))), ("compare_image2", ("candidate2.jpg", open("./candidate2.jpg", "rb"))), ("compare_image3", ("candidate3.jpg", open("./candidate3.jpg", "rb"))), ] response = requests.request("POST", "https://apick.app/rest/image_similarity", headers={"Authorization": "Bearer " + os.environ["APICK_API_KEY"]}, files=parts, timeout=(10, 120)) response.raise_for_status() result = response.json() print(result) ``` ### php ```php new CURLFile('./original.jpg'), 'compare_image1' => new CURLFile('./candidate1.jpg'), 'compare_image2' => new CURLFile('./candidate2.jpg'), 'compare_image3' => new CURLFile('./candidate3.jpg'), ]; $curl = curl_init('https://apick.app/rest/image_similarity'); curl_setopt_array($curl, [ CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => $headers, CURLOPT_POSTFIELDS => $form, CURLOPT_RETURNTRANSFER => true, CURLOPT_CONNECTTIMEOUT => 10, CURLOPT_TIMEOUT => 120, ]); $body = curl_exec($curl); if ($body === false) { throw new RuntimeException(curl_error($curl)); } $status = curl_getinfo($curl, CURLINFO_HTTP_CODE); curl_close($curl); if ($status >= 400) { throw new RuntimeException($body); } $result = json_decode($body, true, 512, JSON_THROW_ON_ERROR); print_r($result); ``` ## 사용 예시 1. 원본과 후보 이미지 비교 등록된 원본과 새로 올라온 이미지가 같은지 확인합니다. ```bash curl --fail-with-body --request POST 'https://apick.app/rest/image_similarity' \ --header "Authorization: Bearer $APICK_API_KEY" \ --form 'image=@./original.jpg' \ --form 'compare_image1=@./candidate1.jpg' ``` - `data.output.compare_image1`이 1에 가까울수록 비슷합니다. 기준 점수는 실제 데이터로 정하세요. ## 사용 예시 2. 여러 장을 한 번에 비교 중복 상품 사진을 찾을 때 비교 이미지를 `compare_image1`부터 번호를 이어서 여러 장 보냅니다(최대 1,000장). ```bash curl --fail-with-body --request POST 'https://apick.app/rest/image_similarity' \ --header "Authorization: Bearer $APICK_API_KEY" \ --form 'image=@./original.jpg' \ --form 'compare_image1=@./a.jpg' \ --form 'compare_image2=@./b.jpg' \ --form 'compare_image3=@./c.jpg' ``` - `data.output`의 키(`compare_image1` …)마다 점수가 옵니다. 가장 높은 키가 가장 비슷한 이미지입니다. - 요금은 기본 요금 + 비교 이미지 1장당 2P입니다. ## 코드·오류 ### 업무 실패 응답 입력 오류·대상 없음·일시 실패는 data.error(사유)와 data.success=0으로 오며 api.cost는 0(과금 없음)입니다. HTTP 상태는 400·404·408·424 중 하나입니다. 입력 오류는 값을 고쳐 다시 요청하고, 408·424는 잠시 후 한 번 다시 시도하세요. ```json { "data": { "error": "입력값을 확인해 주세요.", "success": 0 }, "api": { "success": true, "cost": 0, "ms": 5 } } ``` ## 상세 기능·요금 업로드 용량 제한: 50MB multipart/form-data 요청에 포함된 첨부 이미지 합계는 최대 50MB입니다. 제한을 초과하면 HTTP 413과 REQUEST_TOO_LARGE 오류가 반환되며 과금되지 않습니다. 이용 전 확인 중복 상품 사진 찾기, 원본 이미지 도용 확인, 업로드 이미지가 등록된 이미지와 같은지 검사할 때 사용합니다. PNG·JPEG·WEBP·BMP 이미지를 받습니다. 비교 이미지는 compare_image1, compare_image2, compare_image3 … 처럼 1부터 빠짐없이 번호를 붙여 최대 1,000장까지 보냅니다. 번호가 중간에 빠지면 그 뒤의 이미지는 비교하지 않습니다. 점수는 비슷한 이미지일수록 1에 가깝습니다. 몇 점부터 같은 이미지로 볼지는 실제 데이터로 점수 분포를 확인해 정하세요. 요금은 기본 10P에 비교 이미지 1장당 2P가 더해집니다(비교 이미지 3장이면 10P + 6P). 실패·시간 초과 응답은 과금되지 않습니다. ## 상세 요청 항목설정 메서드·주소POST https://apick.app/rest/image_similarity 인증 헤더Authorization: Bearer 내 계정의 API 인증키 본문 형식multipart/form-data 요청 예시 form-data 전체 예제 보기 ## 상세 응답 필드타입설명 dataobject비교 결과 outputobject비교 이미지 필드 이름(compare_image1, compare_image2 …)을 키로, 기준 이미지와의 유사도 0~1을 값으로 담은 객체입니다. 1에 가까울수록 비슷하며, 보낸 비교 이미지 수만큼 키가 있습니다. compare_image{n}numbern번째 비교 이미지의 유사도 0~1입니다. 1에 가까울수록 비슷합니다. successinteger처리 결과입니다. 1: 성공(과금), 0: 실패, 3: 시간 초과(과금 없음). apiobject호출 공통 정보 successboolean요청을 정상 처리했는지 여부입니다. costinteger이번 요청에서 차감된 포인트입니다. msinteger처리 시간(밀리초)입니다. pl_idinteger결제 기록 번호입니다. 문의할 때 함께 알려 주세요. 응답 예시 { "data": { "output": { "compare_image1": 0.8199545438545536, "compare_image2": 0.5330405783587735, "compare_image3": 0.9999999852726211 }, "success": 1 }, "api": { "success": true, "cost": 16, "ms": 1023, "pl_id": 1237778 } } 위 예시에서 compare_image3은 기준 이미지와 사실상 같은 이미지이고, compare_image2는 다른 이미지로 볼 수 있습니다. ## 상세 코드·정책 오류와 대처 실패하면 data.error에 문구가 담기고 api.cost는 0입니다. HTTPdata.error대처 400비교대상 이미지는 최대 1000개 까지 입력 가능합니다.비교 이미지를 1,000장 이하로 나눠 여러 번 요청하세요. 400파일 유형이 맞지 않습니다. 이미지 형식의 파일만 허용됩니다.기준·비교 이미지가 모두 이미지 파일인지 확인하세요. 424첨부파일이 없습니다.image와 compare_image1을 모두 보냈는지 확인하세요. 424알 수 없는 이유로 실패했습니다.이미지를 JPEG 또는 PNG로 다시 저장해 한 번 더 요청하세요. 408처리 시간 초과로 실패했습니다.data.success가 3입니다. 비교 이미지 수를 줄여 나눠 요청하세요. ## 상세 예제 호출 예시 기준 이미지 1장과 비교 이미지를 compare_image1 부터 순서대로 붙여 보냅니다. 키는 환경변수 APICK_API_KEY 에서 읽습니다. JavaScript 예시 form-data 전체 예제 보기 Python 예시 form-data 전체 예제 보기