API 개요

ImageToTable.ai의 v1 API는 실제 문서의 사진, 스캔본, PDF에서 구조화된 데이터를 추출하여 JSON으로 반환합니다. 이 페이지에서는 이 문서에서 다루는 모든 내용의 기반이 되는 네 가지 리소스를 소개합니다.

핵심 개념

네 가지 리소스가 API의 전체 범위를 포괄합니다. 참조 섹션의 모든 엔드포인트는 이 중 하나를 대상으로 작동합니다.

문서 — 처리된 개별 페이지입니다. 이미지 또는 PDF 페이지를 업로드하여 생성합니다(여러 페이지로 된 PDF를 업로드하면 페이지당 여러 개의 문서가 생성됩니다. 문서 참조 참조). 문서는 비동기 작업 모델 가이드에 자세히 설명된 상태 수명 주기(queued → processing → succeeded / failed / canceled)를 거칩니다.
배치 — 함께 업로드되어 처리되는 문서의 명명된 그룹입니다. 모든 문서는 batch_name으로 식별되는 정확히 하나의 배치에 속합니다. 처리 시작, 상태 확인, 결과 가져오기는 배치 수준에서 수행합니다.
템플릿 — 매번 추출하려는 필드 세트를 저장해 재사용하는 기능입니다. 템플릿을 사용하면 모든 process 호출에서 동일한 필드를 다시 선언할 필요가 없습니다.
필드 — 문서에서 추출하려는 단일 명명된 값입니다. 필드는 템플릿에 포함되거나, 템플릿을 생성하지 않고 단일 process 호출에서 인라인으로 일회성 선언할 수 있습니다.

구성 요소 간 관계

배치에 파일을 하나 이상 업로드하면 각 파일이 문서가 됩니다. 그런 다음 배치 처리를 시작하며, 저장된 템플릿을 지정하거나 요청 본문에 필드를 직접 나열하여 API에 원하는 필드를 알려줍니다. 둘 다 지정하지 않으면 API가 자체적으로 적절한 열을 추론합니다. 처리가 완료되면 배치 결과를 가져옵니다. 각 문서는 필드 이름을 키로 하는 line_items 객체 배열과 함께 반환됩니다.

JSON이 기본 형식입니다

JSON은 모든 엔드포인트의 표준이자 완전 지원되는 응답 형식입니다. Excel(.xlsx) 및 Word(.docx) 내보내기는 동일한 데이터를 기반으로 한 편의 다운로드 기능이며(배치 참조 참조), 별도의 데이터 모델이 아닙니다. API 통합은 JSON 구조를 기준으로 구축해야 합니다.

인증 및 액세스

모든 v1 요청은 Authorization: Bearer <key>로 전송되는 API 키를 통해 인증됩니다. 동일한 브라우저에서 로그인한 경우에도 세션 쿠키 대체는 없습니다. v1 API는 유료 플랜에서 사용할 수 있습니다. 무료 플랜 계정은 plan_required 오류를 받게 됩니다. 키를 찾는 방법은 환경 설정을 참조하세요.

다음 단계

첫 번째 호출을 준비되셨나요? 빠른 시작에서 키 획득, 문서 업로드, 처리 시작, 결과 가져오기까지 약 5분 만에 전체 과정을 안내합니다. 전체 엔드포인트 목록은 API 참조를 참조하세요. AI 코딩 어시스턴트를 사용하여 통합하는 경우, OpenAPI 3.1 사양을 직접 참조하세요. 모든 참조 페이지의 기반이 되는 동일한 스키마로, 처음부터 끝까지 기계가 읽을 수 있습니다.