무료 가입

내 문서 목록 API

명세 내보내기

보관 중인 내 문서 목록과 보관기한을 확인합니다.

POSThttps://apick.app/rest/document_list

인증: Bearer 키
요청 형식: form-data
응답: JSON
경로: 1개
요금: 무료

요청 예제 보기 ↓오류 코드 요금

알아둘 점

문서 작성 순서

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 이하입니다.

가격과 보관

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

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

요청과 응답

API 요청

POST/rest/document_list

Bearer 인증
application/json
JSON 응답

요청 예제

curl --fail-with-body --request POST "https://apick.app/rest/document_list" \
  --header "Authorization: Bearer $APICK_API_KEY" \
  --header "Content-Type: application/json" \
  --data-binary @document-request.json
# document-request.json에 아래 JSON을 저장하고 요청 ID와 문서 식별자를 바꿉니다.
# {}

curl --fail-with-body --request POST "https://apick.app/rest/document_list" \
  --header "Authorization: Bearer $APICK_API_KEY" \
  --header "Content-Type: application/json" \
  --data-binary @document-request.json
# document-request.json에 아래 JSON을 저장하고 요청 ID와 문서 식별자를 바꿉니다.
# {}

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

const body = {};
const response = await fetch("https://apick.app/rest/document_list", {
  method: "POST",
  headers: { Authorization: "Bearer " + process.env.APICK_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify(body), signal: AbortSignal.timeout(120_000)
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

const body = {};
const response = await fetch("https://apick.app/rest/document_list", {
  method: "POST",
  headers: { Authorization: "Bearer " + process.env.APICK_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify(body), signal: AbortSignal.timeout(120_000)
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

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

import os, json, requests
body = json.loads("{}")
response = requests.post("https://apick.app/rest/document_list", json=body, headers={"Authorization": "Bearer " + os.environ["APICK_API_KEY"]}, timeout=120)
response.raise_for_status()
print(response.json())

import os, json, requests
body = json.loads("{}")
response = requests.post("https://apick.app/rest/document_list", json=body, headers={"Authorization": "Bearer " + os.environ["APICK_API_KEY"]}, timeout=120)
response.raise_for_status()
print(response.json())

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

<?php
$body = json_decode('{}', true);
$curl = curl_init("https://apick.app/rest/document_list");
curl_setopt_array($curl, [CURLOPT_POST => true, CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("APICK_API_KEY"), "Content-Type: application/json"], CURLOPT_POSTFIELDS => json_encode($body), CURLOPT_RETURNTRANSFER => true, CURLOPT_TIMEOUT => 120]);
$result = curl_exec($curl);
if ($result === false || curl_getinfo($curl, CURLINFO_HTTP_CODE) >= 400) throw new RuntimeException("문서 요청 실패");
curl_close($curl);
echo $result;

<?php
$body = json_decode('{}', true);
$curl = curl_init("https://apick.app/rest/document_list");
curl_setopt_array($curl, [CURLOPT_POST => true, CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("APICK_API_KEY"), "Content-Type: application/json"], CURLOPT_POSTFIELDS => json_encode($body), CURLOPT_RETURNTRANSFER => true, CURLOPT_TIMEOUT => 120]);
$result = curl_exec($curl);
if ($result === false || curl_getinfo($curl, CURLINFO_HTTP_CODE) >= 400) throw new RuntimeException("문서 요청 실패");
curl_close($curl);
echo $result;

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

응답 예시

공개된 정적 응답 예제가 없는 경로입니다. 왼쪽 응답 필드에서 제공 범위를 확인하세요.

요청 파라미터 없음

추가 폼 항목이 없습니다. 인증 헤더만 보내면 됩니다.

응답 필드

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

입력 조건·전송 규칙

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

파라미터

타입

필수

설명

응답 처리

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

오류 코드

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

HTTP 상태전송·인증·입력 오류
api.successAPI 처리 여부
data · result업무 결과와 오류 문구
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·파일 크기·필드 개수를 확인하세요. 서비스별 제한이 우선 적용됩니다.

요금·이용 조건

기본 요금무료

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

연동 팁

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

내 문서 목록 API

알아둘 점

문서 작성 순서

가격과 보관

요청과 응답

API 요청

요청 파라미터 없음

응답 필드

입력 조건·전송 규칙

응답 처리

오류 코드

업무 실패 응답 data.error

인증·포인트 오류 result.error 문구

폼 입력 오류 error.code

요금·이용 조건

연동 팁

개발가이드 검색

AI•LLM

전체상품

API 체험하기

요금정책

고객지원

개발가이드