개발가이드문서 자동작성AI 문서 작성

AI 문서 작성 API

명세 내보내기
OpenAPI 3.0.3Postman 컬렉션Markdown

에이픽에이전트로 문서 초안·양식 채우기·선택 문장 수정을 제안받습니다.

POSThttps://apick.app/rest/document_ai_write
인증
Bearer 키
요청 형식
form-data
응답
JSON
경로
1개
요금
20P

알아둘 점

문서 작성 순서

document_create로 문서를 만들고 document_get으로 엽니다. 편집 후 document_update에 현재 version을 넣어 저장합니다. document_quote의 version과 content_hash를 document_download에 전달하면 DOCX를 받습니다. 수정 충돌은 409로 알려 줍니다.

문서 JSON 예: {"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"회의 내용"}]}]}

문단(paragraph), 제목(heading), 표(table), 목록(bulletList·orderedList), 텍스트(text), 서명(image), 페이지 나누기(pageBreak)를 지원합니다. 굵게(bold), 기울임(italic), 밑줄(underline), 글꼴·크기·색상(textStyle)을 지정할 수 있습니다. 본문은 100,000자, 이미지 6개까지이며 서명은 PNG·JPEG data URL 각 300KB 이하입니다.

가격과 보관

20P. 저장·열기·목록·수정·삭제·견적은 무료입니다. 공개 API AI 작성은 성공당 20P이며 웹의 하루 20회 무료 체험과 별도입니다. DOCX 다운로드는 최초 100P이며 같은 문서에서 구매한 내용은 무료로 다시 받습니다. 내용이 바뀌면 새로운 다운로드 가격을 확인해 주세요.

문서는 최초 저장 또는 마지막 수정·다운로드 후 14일간 보관합니다. 열기와 변경 없는 저장은 기한을 연장하지 않습니다. 기한이 지나면 문서와 파일이 삭제됩니다. 본인 문서만 사용할 수 있으며 없는 문서·만료 문서는 404, 잔액 부족은 402로 알려 줍니다. 실패한 AI 작업과 파일 생성은 차감하지 않습니다.

요청과 응답

API 요청
POST/rest/document_ai_write
  • Bearer 인증
  • application/json
  • JSON 응답
요청 파라미터 5개 · 필수 2
파라미터
설명
actionstring선택
draft·fill·polish·summarize·expand 중 하나. 기본 draft
textstring필수
작성할 내용 또는 수정 지시, 최대 3,000자 문자열로 보내며, 빼거나 빈 값으로 보내면 요청이 거부됩니다.
예시
안녕하세요.
documentobject선택
title·form·content를 포함한 현재 문서 JSON 객체로 보내며, 하위 항목 이름과 값을 함께 지정합니다. 생략하면 서버 기본값이 적용됩니다.
selectionstring선택
다듬기·요약·확장할 선택 문장 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다.
request_idstring필수
중복 방지 요청 ID. UUID 권장, 같은 요청의 재시도는 같은 값 문자열로 보내며, 빼거나 빈 값으로 보내면 요청이 거부됩니다.
예시
입력값
응답 필드

이 경로의 응답 형식은 오른쪽 응답 예시를 확인하세요.

입력 조건·전송 규칙

POST https://apick.app/rest/document_ai_write · JSON · Authorization: Bearer 인증키

응답 처리

HTTP 성공과 업무 결과를 구분하세요. 경로별 응답 필드와 예시는 위 요청과 응답에 함께 있습니다.

오류 코드

응답을 아래 순서로 확인하세요. 결과 유무와 과금 여부는 서로 다릅니다.

  1. HTTP 상태전송·인증·입력 오류
  2. api.successAPI 처리 여부
  3. data · result업무 결과와 오류 문구
  4. api.cost이번 요청의 과금
업무 실패 응답 data.error
  • 입력값이 맞지 않거나 대상 자료가 없거나 일시적으로 처리하지 못하면 data.error(사유 문구)와 data.success=0을 돌려줍니다. HTTP 상태는 사유에 따라 400·404·408·424 중 하나입니다.
  • 이때 api.cost는 0이며 과금되지 않습니다. data.error 문구를 그대로 기록하고 사용자에게 보여 주세요.
  • 입력 오류(400)는 값을 고친 뒤 다시 요청하세요. 408·424는 잠시 후 한 번 다시 시도하고, 같은 입력으로 짧은 간격의 자동 반복은 하지 마세요.
{
  "data": {
    "error": "입력값을 확인해 주세요.",
    "success": 0
  },
  "api": {
    "success": true,
    "cost": 0,
    "ms": 5
  }
}
인증·포인트 오류 result.error 문구
코드
HTTP
의미·조치
유효하지 않은 API키 입니다.
401
Authorization: Bearer 헤더의 인증키를 확인하세요.
허용되지 않은 IP주소 입니다.
401
마이페이지의 허용 IP 설정과 요청 서버 IP를 확인하세요.
비활성화된 계정입니다.
401
계정 이용 상태를 고객지원으로 문의하세요.
사용 가능한 포인트이 부족합니다.
200
HTTP 200이어도 result.error가 있으면 실패입니다. 포인트를 충전한 뒤 다시 요청하세요. 이 응답은 과금되지 않습니다.
인증 정보를 확인할 수 없습니다.
424
일시적인 확인 실패입니다. 잠시 후 다시 시도하세요.
폼 입력 오류 error.code
코드
HTTP
의미·조치
FORM_DATA_INVALID
400
필드 이름·값의 타입·배열 인덱스를 확인하세요. 인덱스는 0부터 연속으로 사용합니다.
FORM_DATA_FIELD_CONFLICT
400
같은 값과 중첩 경로를 동시에 지정하지 마세요.
MULTIPART_LIMIT_OR_PARSE_ERROR
400·413
boundary·파일 크기·필드 개수를 확인하세요. 서비스별 제한이 우선 적용됩니다.

요금·이용 조건

기본 요금20P

실제 차감 금액은 응답의 api.cost로 확인하세요. 상세 요금은 요금정책에서 볼 수 있습니다.

연동 팁

  • 요청 예제의 오류 처리 포함 모드는 시간 제한과 업무 실패 판정을 함께 보여줍니다.
  • 인증키는 서버 환경변수에 두고 브라우저·앱에 넣지 마세요.
  • HTTP 성공과 업무 결과를 구분하고, 실패 응답의 오류 문구를 그대로 기록하세요.

개발가이드 검색

API 이름·경로·파라미터·오류 코드로 찾을 수 있습니다.

표시 가격은 기본 단가입니다. 상세 과금 조건은 각 가이드에서 확인하세요.