DoPaMing · 데스크톱 문서 검색과 웹서비스
API

문서 처리 기능을 API로 제공합니다

OCR, 문서 채팅, 문서 비교, 한글 문서 이미지 변환을 서비스나 내부 업무 시스템에 연결할 수 있습니다. 아래 스펙은 연동 검토를 위한 요청·응답 예시이며, 실제 접속 주소와 인증 정보는 도입 환경에 맞춰 별도로 제공합니다.

공통 연동 방식

모든 API는 계약 후 발급되는 API Base URL과 API Key를 사용합니다. 파일 업로드는 multipart/form-data 또는 사전 업로드된 문서 ID 방식으로 제공할 수 있습니다.

AuthorizationBearer YOUR_API_KEY
POST/v1/ocr/jobs

OCR API

이미지 또는 PDF에서 텍스트, 표, 문단 블록, 페이지별 결과를 추출합니다.

입력

  • 파일: PNG, JPG, WEBP, TIFF, PDF
  • 옵션: 언어, 페이지 범위, 결과 포맷

응답

  • 작업 ID
  • 페이지별 텍스트 블록
  • Markdown 결과
  • 인식 영역 메타데이터
Request예시
{
  "file": "<binary>",
  "options": {
    "language": "kor+eng",
    "output": ["json", "markdown"]
  }
}
Response예시
{
  "job_id": "ocr_job_01H...",
  "status": "completed",
  "pages": [
    {
      "page": 1,
      "text": "문서에서 추출된 텍스트",
      "blocks": [
        {
          "type": "paragraph",
          "text": "본문 문단",
          "bbox": [96, 144, 640, 188]
        }
      ]
    }
  ],
  "markdown": "# 문서 제목\n\n본문..."
}
POST/v1/doc-chat/messages

문서 채팅 API

업로드한 문서를 기준으로 질의응답을 수행하고, 답변 근거와 관련 문서를 함께 반환합니다.

입력

  • 문서 ID 또는 업로드 파일
  • 사용자 질문
  • 대화 이력

응답

  • 답변
  • 참고 구간
  • 관련 파일 후보
  • 신뢰도 점수
Request예시
{
  "document_id": "doc_01H...",
  "messages": [
    {
      "role": "user",
      "content": "계약 해지 조건을 요약해줘"
    }
  ]
}
Response예시
{
  "answer": "계약 해지는 서면 통지 후 ...",
  "citations": [
    {
      "page": 3,
      "text": "해지 조건 관련 원문 일부",
      "score": 0.91
    }
  ],
  "related_documents": [
    {
      "title": "계약 변경 합의서",
      "score": 0.78
    }
  ]
}
POST/v1/documents/compare

문서 비교 API

두 문서의 본문, 표, 변경 블록, 페이지 이미지상 차이 영역을 비교합니다.

입력

  • 변경 전 파일
  • 변경 후 파일
  • 비교 옵션

응답

  • 추가·삭제·수정 통계
  • 블록별 diff
  • 페이지 프리뷰
  • 이미지 차이 영역
Request예시
{
  "before_file": "<binary>",
  "after_file": "<binary>",
  "options": {
    "include_preview": true,
    "highlight_changes": true
  }
}
Response예시
{
  "stats": {
    "added": 2,
    "removed": 1,
    "modified": 3,
    "unchanged": 18
  },
  "diffs": [
    {
      "type": "modified",
      "before": { "text": "기존 조항" },
      "after": { "text": "변경 조항" }
    }
  ],
  "previews": {
    "before": {
      "pages": [
        {
          "page": 1,
          "image": "<base64 image>",
          "highlights": [
            { "x": 120, "y": 240, "width": 180, "height": 42 }
          ]
        }
      ]
    }
  }
}
POST/v1/hangul/render

한글 문서 이미지 변환 API

HWP/HWPX 문서를 페이지 단위 이미지로 변환해 웹 미리보기나 검수 화면에 사용할 수 있게 제공합니다.

입력

  • HWP 또는 HWPX 파일
  • 페이지 범위
  • 이미지 포맷과 DPI

응답

  • 페이지별 이미지
  • 페이지 크기
  • 렌더링 경고
Request예시
{
  "file": "<binary>",
  "options": {
    "format": "png",
    "dpi": 144,
    "pages": "1-5"
  }
}
Response예시
{
  "document_type": "hwpx",
  "page_count": 5,
  "pages": [
    {
      "page": 1,
      "width": 1191,
      "height": 1684,
      "image": "<base64 image>"
    }
  ],
  "warnings": []
}

공통 상태 코드

200요청 성공
202비동기 작업 접수
400요청 형식 오류
401인증 실패
413파일 크기 초과
429사용량 한도 초과
500처리 중 서버 오류