API 개요

DocMap API는 AI 기반 템플릿을 사용하여 PDF 문서에서 구조화된 데이터를 추출하는 REST 엔드포인트를 제공합니다.

기본 URL

모든 API 요청은 다음 주소로 전송됩니다:

https://api.docmap.io

모든 버전 지정 엔드포인트는 /v1/ 접두사가 붙습니다.

인증

모든 /v1/* 엔드포인트는 Bearer 토큰이 포함된 Authorization 헤더가 필요합니다. API 키 또는 Firebase ID 토큰을 사용할 수 있습니다:

Authorization: Bearer dm_live_abc123def456ghi789jkl012mno345

API 키는 대시보드 > 설정 > API 키에서 생성 및 관리하거나 API 키 엔드포인트를 통해 관리할 수 있습니다. 자세한 내용은 인증 가이드를 참조하세요.

콘텐츠 타입

모든 요청 및 응답 본문은 JSON을 사용합니다:

Content-Type: application/json

요금 제한

추출 요청은 플랜에 따른 월간 한도의 적용을 받습니다. GET /v1/usage 엔드포인트를 사용하여 현재 사용량을 확인하세요. 플랜별 할당량은 요금 제한 가이드를 참조하세요.

엔드포인트 요약

메서드	경로	설명
GET	/health	상태 확인 (인증 불필요)
POST	/v1/extractions/run	PDF 문서에서 추출 실행
GET	/v1/extractions	추출 기록 목록 조회
DELETE	/v1/extractions/{id}	추출 기록 삭제
GET	/v1/usage	현재 청구 기간의 사용량 조회
POST	/v1/api-keys	새 API 키 생성
GET	/v1/api-keys	모든 활성 API 키 목록 조회
DELETE	/v1/api-keys/{id}	API 키 폐기

상태 확인

GET /health는 유일한 비인증 엔드포인트입니다. API에 접근 가능한지 확인하는 데 사용합니다.

curl

curl https://api.docmap.io/health

TypeScript

const res = await fetch('https://api.docmap.io/health')
const data = await res.json()
console.log(data) // { status: "ok" }

Python

import requests

res = requests.get("https://api.docmap.io/health")
print(res.json())  # {"status": "ok"}

응답:

{ "status": "ok" }

오류 형식

모든 오류 응답은 일관된 구조를 따릅니다:

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or expired API key."
  }
}

전체 오류 코드 목록과 의미는 오류 코드 레퍼런스를 참조하세요.

OpenAPI 사양

도구 및 클라이언트 생성을 위한 전체 OpenAPI 사양을 사용할 수 있습니다:

• OpenAPI JSON: https://api.docmap.io/openapi.json
• Swagger UI: https://api.docmap.io/docs