이미지 텍스트 추출(OCR)

명세 내보내기

OpenAPI 3.0.3 Postman 컬렉션 Markdown

OCR(Optical Character Recognition) 이미지 파일에서 텍스트를 추출합니다.

POST/rest/ocr

요청 예제로 이동 ↓

기능·제공 범위

인증: Bearer 키
요청: form-data
응답: JSON
요금·이용 조건: 기본 단가 12P · 건당

빠른 시작

서버의 APICK_API_KEY를 준비하고 입력값을 바꾸세요. 아래에서 경로별 입력·응답·실행 환경을 함께 확인할 수 있습니다.

요청과 응답

API 요청 예제직접 실행하지 않습니다POST /rest/ocr

POSIX 셸 · APICK_API_KEY 환경변수를 먼저 설정하세요. Windows에서는 Unicode 지원 cURL을 사용하세요.

curl --fail-with-body --request POST 'https://apick.app/rest/ocr' \
  --header "Authorization: Bearer $APICK_API_KEY" \
  --form 'image=@/C:/Users/user/Desktop/sample_idcard.png'

Node.js 22+ · 서버에서 실행하는 ESM 예제입니다. 키를 브라우저에 넣지 마세요.

import { readFile } from "node:fs/promises";
const form = new FormData();
form.append("image", new Blob([await readFile("/C:/Users/user/Desktop/sample_idcard.png")]), "sample_idcard.png");
const response = await fetch("https://apick.app/rest/ocr", {
  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 3 · requests 설치가 필요합니다. 키는 서버 환경변수로 읽습니다.

import os
import requests
parts = [
    ("image", ("sample_idcard.png", open("/C:/Users/user/Desktop/sample_idcard.png", "rb"))),
]
response = requests.request("POST", "https://apick.app/rest/ocr",
    headers={"Authorization": "Bearer " + os.environ["APICK_API_KEY"]},
    files=parts,
    timeout=(10, 120))
response.raise_for_status()
result = response.json()
print(result)

PHP 8 · cURL 확장이 필요합니다. 키는 서버 환경변수로 읽습니다.

<?php
$headers = ["Authorization: Bearer " . getenv("APICK_API_KEY")];
$form = [
    'image' => new CURLFile('/C:/Users/user/Desktop/sample_idcard.png'),
];
$curl = curl_init('https://apick.app/rest/ocr');
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);

POSIX 셸 · APICK_API_KEY 환경변수를 먼저 설정하세요. Windows에서는 Unicode 지원 cURL을 사용하세요.

curl --fail-with-body --request POST 'https://apick.app/rest/ocr' \
  --header "Authorization: Bearer $APICK_API_KEY" \
  --connect-timeout 10 --max-time 120 \
  --form 'image=@/C:/Users/user/Desktop/sample_idcard.png'

Node.js 22+ · 서버에서 실행하는 ESM 예제입니다. 키를 브라우저에 넣지 마세요.

import { readFile } from "node:fs/promises";
const form = new FormData();
form.append("image", new Blob([await readFile("/C:/Users/user/Desktop/sample_idcard.png")]), "sample_idcard.png");
const response = await fetch("https://apick.app/rest/ocr", {
  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();
if (result.error || result.data?.error || result.result?.error || result.success === false || result.api?.success === false) {
  throw new Error(JSON.stringify(result));
}
console.log(result);

Python 3 · requests 설치가 필요합니다. 키는 서버 환경변수로 읽습니다.

import os
import requests
parts = [
    ("image", ("sample_idcard.png", open("/C:/Users/user/Desktop/sample_idcard.png", "rb"))),
]
response = requests.request("POST", "https://apick.app/rest/ocr",
    headers={"Authorization": "Bearer " + os.environ["APICK_API_KEY"]},
    files=parts,
    timeout=(10, 120))
response.raise_for_status()
result = response.json()
if result.get("error") or (isinstance(result.get("data"), dict) and result["data"].get("error")) or (isinstance(result.get("result"), dict) and result["result"].get("error")) or result.get("success") is False or (result.get("api") or {}).get("success") is False:
    raise RuntimeError(result)
print(result)

PHP 8 · cURL 확장이 필요합니다. 키는 서버 환경변수로 읽습니다.

<?php
$headers = ["Authorization: Bearer " . getenv("APICK_API_KEY")];
$form = [
    'image' => new CURLFile('/C:/Users/user/Desktop/sample_idcard.png'),
];
$curl = curl_init('https://apick.app/rest/ocr');
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);
if (!empty($result["error"]) || !empty($result["data"]["error"]) || !empty($result["result"]["error"]) || ($result["success"] ?? true) === false || ($result["api"]["success"] ?? true) === false) {
    throw new RuntimeException($body);
}
print_r($result);

API 요청

POST/rest/ocr

Bearer 인증 · multipart/form-data · JSON 응답

입력 항목

폼 항목·타입

필수

설명·예제

imagefile

필수

이미지 파일

응답과 성공 판정

HTTP 성공과 업무 결과를 구분하세요. 아래 서비스별 결과 필드가 실제 성공·실패를 나타냅니다.

응답 상태

{
  "data": {
    "result": {
      "text_coordinate": [
        {
          "description": "주민등록증\n홍길동(洪吉洞)\n800101-2345678\n서울특별시 가산디지털1로\n(대륭테크노타운 18차)\n2020.08.16.\n서울특별시 금천구청장 청바",
          "vertices": [
            {
              "x": 56,
              "y": 48
            },
            {
              "x": 612,
              "y": 48
            },
            {
              "x": 612,
              "y": 423
            },
            {
              "x": 56,
              "y": 423
            }
          ]
        },
        {
          "description": "주민등록증",
          "vertices": [
            {
              "x": 109,
              "y": 48
            },
            {
              "x": 371,
              "y": 48
            },
            {
              "x": 371,
              "y": 90
            },
            {
              "x": 109,
              "y": 90
            }
          ]
        },
        {
          "description": "홍길동",
          "vertices": [
            {
              "x": 77,
              "y": 122
            },
            {
              "x": 194,
              "y": 122
            },
            {
              "x": 194,
              "y": 160
            },
            {
              "x": 77,
              "y": 160
            }
          ]
        },
        {
          "description": "(",
          "vertices": [
            {
              "x": 204,
              "y": 122
            },
            {
              "x": 214,
              "y": 122
            },
            {
              "x": 214,
              "y": 160
            },
            {
              "x": 204,
              "y": 160
            }
          ]
        },
        {
          "description": "洪吉洞",
          "vertices": [
            {
              "x": 223,
              "y": 122
            },
            {
              "x": 338,
              "y": 122
            },
            {
              "x": 338,
              "y": 160
            },
            {
              "x": 223,
              "y": 160
            }
          ]
        },
        {
          "description": ")",
          "vertices": [
            {
              "x": 349,
              "y": 122
            },
            {
              "x": 358,
              "y": 122
            },
            {
              "x": 358,
              "y": 160
            },
            {
              "x": 349,
              "y": 160
            }
          ]
        },
        {
          "description": "800101-2345678",
          "vertices": [
            {
              "x": 72,
              "y": 187
            },
            {
              "x": 362,
              "y": 187
            },
            {
              "x": 362,
              "y": 211
            },
            {
              "x": 72,
              "y": 211
            }
          ]
        },
        {
          "description": "서울",
          "vertices": [
            {
              "x": 56,
              "y": 240
            },
            {
              "x": 109,
              "y": 240
            },
            {
              "x": 109,
              "y": 267
            },
            {
              "x": 56,
              "y": 267
            }
          ]
        },
        {
          "description": "특별시",
          "vertices": [
            {
              "x": 112,
              "y": 240
            },
            {
              "x": 188,
              "y": 240
            },
            {
              "x": 188,
              "y": 267
            },
            {
              "x": 112,
              "y": 267
            }
          ]
        },
        {
          "description": "가산",
          "vertices": [
            {
              "x": 208,
              "y": 240
            },
            {
              "x": 260,
              "y": 240
            },
            {
              "x": 260,
              "y": 267
            },
            {
              "x": 208,
              "y": 267
            }
          ]
        },
        {
          "description": "디지털",
          "vertices": [
            {
              "x": 264,
              "y": 240
            },
            {
              "x": 339,
              "y": 240
            },
            {
              "x": 339,
              "y": 267
            },
            {
              "x": 264,
              "y": 267
            }
          ]
        },
        {
          "description": "1",
          "vertices": [
            {
              "x": 346,
              "y": 240
            },
            {
              "x": 355,
              "y": 240
            },
            {
              "x": 355,
              "y": 267
            },
            {
              "x": 346,
              "y": 267
            }
          ]
        },
        {
          "description": "로",
          "vertices": [
            {
              "x": 359,
              "y": 240
            },
            {
              "x": 382,
              "y": 240
            },
            {
              "x": 382,
              "y": 267
            },
            {
              "x": 359,
              "y": 267
            }
          ]
        },
        {
          "description": "(",
          "vertices": [
            {
              "x": 60,
              "y": 272
            },
            {
              "x": 67,
              "y": 272
            },
            {
              "x": 67,
              "y": 298
            },
            {
              "x": 60,
              "y": 298
            }
          ]
        },
        {
          "description": "대륭",
          "vertices": [
            {
              "x": 73,
              "y": 272
            },
            {
              "x": 123,
              "y": 272
            },
            {
              "x": 123,
              "y": 298
            },
            {
              "x": 73,
              "y": 298
            }
          ]
        },
        {
          "description": "테크노",
          "vertices": [
            {
              "x": 128,
              "y": 272
            },
            {
              "x": 205,
              "y": 272
            },
            {
              "x": 205,
              "y": 298
            },
            {
              "x": 128,
              "y": 298
            }
          ]
        },
        {
          "description": "타운",
          "vertices": [
            {
              "x": 209,
              "y": 272
            },
            {
              "x": 260,
              "y": 272
            },
            {
              "x": 260,
              "y": 298
            },
            {
              "x": 209,
              "y": 298
            }
          ]
        },
        {
          "description": "18",
          "vertices": [
            {
              "x": 278,
              "y": 272
            },
            {
              "x": 302,
              "y": 272
            },
            {
              "x": 302,
              "y": 298
            },
            {
              "x": 278,
              "y": 298
            }
          ]
        },
        {
          "description": "차",
          "vertices": [
            {
              "x": 304,
              "y": 272
            },
            {
              "x": 329,
              "y": 272
            },
            {
              "x": 329,
              "y": 298
            },
            {
              "x": 304,
              "y": 298
            }
          ]
        },
        {
          "description": ")",
          "vertices": [
            {
              "x": 334,
              "y": 272
            },
            {
              "x": 342,
              "y": 272
            },
            {
              "x": 342,
              "y": 298
            },
            {
              "x": 334,
              "y": 298
            }
          ]
        },
        {
          "description": "2020.08.16",
          "vertices": [
            {
              "x": 248,
              "y": 354
            },
            {
              "x": 405,
              "y": 355
            },
            {
              "x": 405,
              "y": 376
            },
            {
              "x": 248,
              "y": 375
            }
          ]
        },
        {
          "description": ".",
          "vertices": [
            {
              "x": 413,
              "y": 355
            },
            {
              "x": 419,
              "y": 355
            },
            {
              "x": 419,
              "y": 375
            },
            {
              "x": 413,
              "y": 375
            }
          ]
        },
        {
          "description": "서울",
          "vertices": [
            {
              "x": 152,
              "y": 380
            },
            {
              "x": 218,
              "y": 380
            },
            {
              "x": 218,
              "y": 422
            },
            {
              "x": 152,
              "y": 422
            }
          ]
        },
        {
          "description": "특별시",
          "vertices": [
            {
              "x": 223,
              "y": 380
            },
            {
              "x": 321,
              "y": 380
            },
            {
              "x": 321,
              "y": 422
            },
            {
              "x": 223,
              "y": 422
            }
          ]
        },
        {
          "description": "금천구",
          "vertices": [
            {
              "x": 347,
              "y": 380
            },
            {
              "x": 447,
              "y": 380
            },
            {
              "x": 447,
              "y": 422
            },
            {
              "x": 347,
              "y": 422
            }
          ]
        },
        {
          "description": "청장",
          "vertices": [
            {
              "x": 452,
              "y": 380
            },
            {
              "x": 518,
              "y": 380
            },
            {
              "x": 518,
              "y": 422
            },
            {
              "x": 452,
              "y": 422
            }
          ]
        },
        {
          "description": "청바",
          "vertices": [
            {
              "x": 532,
              "y": 380
            },
            {
              "x": 612,
              "y": 380
            },
            {
              "x": 612,
              "y": 422
            },
            {
              "x": 532,
              "y": 422
            }
          ]
        }
      ],
      "full_text": "주민등록증\n홍길동(洪吉洞)\n800101-2345678\n서울특별시 가산디지털1로\n(대륭테크노타운 18차)\n2020.08.16.\n서울특별시 금천구청장 청바"
    },
    "success": 1
  },
  "api": {
    "success": true,
    "cost": 12,
    "ms": 608,
    "pl_id": 4106065
  }
}

필드·타입

의미·조건

dataobject

조회 데이터

data.resultobject

추출 결과

data.result.text_coordinatearray

텍스트 좌표 리스트

data.result.text_coordinate[].descriptionstring

내용

data.result.text_coordinate[].verticesarray

꼭지점 좌표 리스트

data.result.text_coordinate[].vertices[].xinteger

x 좌표

data.result.text_coordinate[].vertices[].yinteger

y 좌표

data.result.full_textstring

전체 추출 결과

data.successinteger

과금 여부0: 실패1: 성공3: 실패(timeout)

apiobject

API 호출 공통 데이터

api.successboolean

API 서버 정상 응답 여부

api.costinteger

API 호출 요금

api.msinteger

API 응답 시간

api.pl_idinteger

API 결제 로그 ID

정적 연동 예시입니다. 실제 계정·개인정보를 조회하지 않습니다.

추가 입력 조건·전송 규칙

Header

이름

필수

설명

Authorization

Bearer 인증키

응답 상세

서비스 고유 응답·필드 상세 설명

Body

이름

타입

설명

data

Object

조회 데이터

result

Object

추출 결과

text_coordinate

Array

텍스트 좌표 리스트

{}

Object

텍스트 좌표 정보

description

String

내용

vertices

Array

꼭지점 좌표 리스트

{}

Object

꼭지점 좌표

Integer

x 좌표

Integer

y 좌표

full_text

String

전체 추출 결과

success

Integer

과금 여부
0: 실패
1: 성공
3: 실패(timeout)

api

Object

API 호출 공통 데이터

success

Boolean

API 서버 정상 응답 여부

cost

Integer

API 호출 요금

Integer

API 응답 시간

pl_id

Integer

API 결제 로그 ID

경로별 응답 예시와 필드 명세는 위 API 요청 설명에 붙어 있습니다. JSON을 파일로 저장하기 전에는 Content-Type과 오류를 확인하세요.

상태·오류·재시도

HTTP 상태 → API 처리 여부 → 업무 상태 순서로 확인하세요. 결과 유무와 과금 여부는 서로 다릅니다.

코드

HTTP

의미·조치

OCR_IMAGE_MISSING

400

이미지 파일을 첨부하세요.

OCR_UNSUPPORTED_IMAGE

400

지원 이미지 형식을 사용하세요.

OCR_IMAGE_TOO_LARGE

413

50MB 이하 이미지를 사용하세요.

OCR_NO_TEXT

422

판독 가능한 글자가 없습니다. 선명한 이미지를 사용하세요.

OCR_TIMEOUT

408

처리 시간이 초과됐습니다. 이미지 크기와 품질을 확인하세요.

OCR_CREDENTIALS_ERROR

424