# URL을 Markdown·JSON으로 변환 입력한 URL의 메뉴·광고·각주를 걷어 낸 본문을 Markdown이나 구조화된 JSON으로 정리해 돌려줍니다. 인증: Authorization: Bearer $APICK_API_KEY 본문 있는 REST 요청: multipart/form-data. GET 본문 및 MCP JSON-RPC 규격은 해당 명세를 따릅니다. 인증키는 서버에 보관하세요. 모든 예제는 정적 자료입니다. ## POST /rest/url_to_markdown 응답 필드 - `data` (object): 요청 처리 결과 묶음입니다. 조회한 값·작업 상태·오류 설명이 이 안에 들어 있으며, 실제 하위 필드 구성은 서비스마다 다릅니다. 값이 없으면 null·빈 배열·필드 생략 중 해당 서비스의 규칙을 따릅니다. - `data.url` (string): 실제로 연 주소입니다. 입력 주소가 다른 곳으로 넘겨졌으면 그 최종 주소입니다. - `data.title` (string): 문서 제목입니다. 없으면 빈 문자열입니다. 대상의 제목 또는 이름입니다. 서비스에 따라 상품명·영상 제목·페이지 제목을 뜻하며, 줄바꿈·이모지가 포함될 수 있습니다. - `data.description` (string): 문서 설명(요약 메타)입니다. 없으면 빈 문자열입니다. 대상의 설명문입니다. 게시자·서비스가 작성한 소개문이며, 줄바꿈과 이모지가 포함될 수 있습니다. 비어 있으면 설명이 등록되지 않은 것입니다. - `data.markdown` (string): 본문을 옮긴 Markdown 입니다. format이 json이면 이 필드가 없습니다. - `data.json` (object): 'json' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다. - `data.json.headings` (array): 제목 구조입니다. 각 항목에 level(1~6)과 text가 들어 있습니다. - `data.json.headings[].level` (integer): 'level' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.json.headings[].text` (string): 'text' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다. - `data.json.text` (string): Markdown 표기를 뺀 평문입니다. 검색 색인에 쓰기 좋습니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. - `data.json.links` (array): 본문 링크 목록입니다. 같은 주소는 한 번만 담고 text·href를 담습니다. - `data.json.links[].text` (string): 'text' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다. - `data.json.links[].href` (string): 'href' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다. - `data.json.images` (array): 본문 이미지 목록입니다. src와 alt를 담습니다. 각 항목의 구성은 서비스에 따라 다르며, 값이 없으면 빈 배열입니다. 항목 수와 순서를 함께 확인하세요. - `data.json.images[].src` (string): 'src' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다. - `data.json.images[].alt` (string): 'alt' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다. - `data.word_count` (integer): 본문 단어 수입니다. 공백 기준으로 셉니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.markdown_chars` (integer): Markdown 본문 글자 수입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.truncated` (boolean): 본문이 max_chars를 넘어 잘렸으면 true입니다. true/false로 오며, 값이 없으면 필드가 생략되거나 null일 수 있습니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다. - `data.success` (integer): 업무 처리 결과 코드입니다. 1은 정상 결과, 0은 실패 또는 무료 응답입니다. 서비스에 따라 2·3처럼 추가 코드를 쓰므로 같은 응답의 status·msg·error 필드도 함께 확인하세요. - `data.error` (string): 오류 원인을 설명하는 문구입니다. 성공 응답에는 없거나 빈 문자열입니다. - `api` (object): API 호출 메타데이터입니다. 이번 요청의 서버 처리 성공 여부(api.success), 실제 차감 포인트(api.cost), 결제 기록 ID(api.pl_id)를 담습니다. 처리 시간(api.ms)은 응답에 포함된 경우에만 제공됩니다. 업무 결과는 data에서 확인합니다. - `api.success` (boolean): API 서버가 이번 요청을 정상 처리했는지 여부입니다. true여도 업무 결과가 실패일 수 있으므로 data.success·data.status와 함께 판단합니다. 인증 실패·잘못된 입력·서버 오류 응답에서는 false입니다. - `api.cost` (integer): 이번 호출에서 실제로 차감된 포인트입니다. 유료 성공 응답에서만 단가만큼 차감되며, 실패·무료 조회·같은 요청의 멱등 재전송은 0입니다. 화면의 표시 단가와 실제 차감액이 다를 수 있으므로 정산은 이 값을 기준으로 합니다. - `api.ms` (integer): 서버가 요청을 받아 응답 본문을 만들기까지 걸린 처리 시간(밀리초)입니다. 네트워크 왕복 시간과 클라이언트 대기 시간은 포함되지 않습니다. - `api.pl_id` (integer): 포인트 차감 기록 ID입니다. 차감이 발생한 호출에만 값이 있으며, 과금 내역을 문의할 때 이 번호를 사용합니다. 무과금 응답은 -1·null이거나 필드가 생략됩니다. ## API 요청: POST /rest/url_to_markdown ### 입력 - `url` (string, 필수): 조회할 대상의 URL입니다. http·https를 포함한 전체 주소를 보내며, 서비스에 따라 영상 ID만 받을 수도 있습니다. - `format` (string, 선택): markdown · json · both(기본) 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다. - `max_chars` (integer, 선택): 본문 최대 글자 수 (기본 100000) 숫자로 보내며, 허용 범위를 벗어나면 요청이 거부됩니다. ### 응답 명세 ```json { "type": "object", "properties": { "data": { "type": "object", "properties": { "url": { "type": "string", "description": "실제로 연 주소입니다. 입력 주소가 다른 곳으로 넘겨졌으면 그 최종 주소입니다." }, "title": { "type": "string", "description": "문서 제목입니다. 없으면 빈 문자열입니다." }, "description": { "type": "string", "description": "문서 설명(요약 메타)입니다. 없으면 빈 문자열입니다." }, "markdown": { "type": "string", "description": "본문을 옮긴 Markdown 입니다. format이 json이면 이 필드가 없습니다." }, "json": { "type": "object", "properties": { "headings": { "type": "array", "items": { "type": "object", "properties": { "level": { "type": "integer" }, "text": { "type": "string" } } }, "description": "제목 구조입니다. 각 항목에 level(1~6)과 text가 들어 있습니다." }, "text": { "type": "string", "description": "Markdown 표기를 뺀 평문입니다. 검색 색인에 쓰기 좋습니다." }, "links": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "href": { "type": "string" } } }, "description": "본문 링크 목록입니다. 같은 주소는 한 번만 담고 text·href를 담습니다." }, "images": { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "alt": { "type": "string" } } }, "description": "본문 이미지 목록입니다. src와 alt를 담습니다." } } }, "word_count": { "type": "integer", "description": "본문 단어 수입니다. 공백 기준으로 셉니다." }, "markdown_chars": { "type": "integer", "description": "Markdown 본문 글자 수입니다." }, "truncated": { "type": "boolean", "description": "본문이 max_chars를 넘어 잘렸으면 true입니다." }, "success": { "type": "integer" }, "error": { "type": "string", "description": "실패 사유 문구입니다. 정상 응답에는 없습니다." } }, "description": "변환 결과 묶음입니다. 실패하면 아래 필드 대신 error 문구가 들어 있습니다." }, "api": { "type": "object", "properties": { "success": { "type": "boolean" }, "cost": { "type": "integer", "description": "이번 호출에서 차감된 포인트입니다. data.error가 있는 실패 응답은 0입니다." }, "ms": { "type": "integer", "description": "요청을 받아 응답을 만들기까지 걸린 시간(밀리초)입니다." }, "pl_id": { "type": "integer" } }, "description": "호출 공통 정보입니다. 처리 여부·차감 포인트·처리 시간·차감 기록 번호가 들어 있습니다." } } } ``` ### 정적 응답 예시 ```json { "data": { "url": "https://example.com/article", "title": "기사 제목", "description": "기사 요약", "markdown": "# 기사 제목\n\n첫 문단입니다.\n\n- 항목 하나\n- 항목 둘", "json": { "headings": [ { "level": 1, "text": "기사 제목" } ], "text": "기사 제목 첫 문단입니다. 항목 하나 항목 둘", "links": [ { "text": "자세히", "href": "https://example.com/more" } ], "images": [ { "src": "https://example.com/a.png", "alt": "그림" } ] }, "word_count": 18, "markdown_chars": 62, "truncated": false, "success": 1 }, "api": { "success": true, "cost": 15, "ms": 4321, "pl_id": 50232 } } ``` ### curl ```curl curl --fail-with-body --request POST 'https://apick.app/rest/url_to_markdown' \ --header "Authorization: Bearer $APICK_API_KEY" \ --form-string 'url=https://example.com/article' \ --form-string 'format=both' ``` ### Node.js (서버 ESM) ```javascript const form = new FormData(); form.append("url", "https://example.com/article"); form.append("format", "both"); const response = await fetch("https://apick.app/rest/url_to_markdown", { method: "POST", headers: { Authorization: "Bearer " + process.env.APICK_API_KEY }, body: form, signal: AbortSignal.timeout(120_000), }); if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`); const result = await response.json(); console.log(result); ``` ### python ```python import os import requests parts = [ ("url", (None, "https://example.com/article")), ("format", (None, "both")), ] response = requests.request("POST", "https://apick.app/rest/url_to_markdown", headers={"Authorization": "Bearer " + os.environ["APICK_API_KEY"]}, files=parts, timeout=(10, 120)) response.raise_for_status() result = response.json() print(result) ``` ### php ```php 'https://example.com/article', 'format' => 'both', ]; $curl = curl_init('https://apick.app/rest/url_to_markdown'); curl_setopt_array($curl, [ CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => $headers, CURLOPT_POSTFIELDS => $form, CURLOPT_RETURNTRANSFER => true, CURLOPT_CONNECTTIMEOUT => 10, CURLOPT_TIMEOUT => 120, ]); $body = curl_exec($curl); if ($body === false) { throw new RuntimeException(curl_error($curl)); } $status = curl_getinfo($curl, CURLINFO_HTTP_CODE); curl_close($curl); if ($status >= 400) { throw new RuntimeException($body); } $result = json_decode($body, true, 512, JSON_THROW_ON_ERROR); print_r($result); ``` ## 사용 예시 1. 기사 본문을 문서 초안으로 가져오기 기사·블로그 글의 본문만 뽑아 위키나 문서 도구에 붙일 때 씁니다. ```bash curl --fail-with-body --request POST 'https://apick.app/rest/url_to_markdown' \ --header "Authorization: Bearer $APICK_API_KEY" \ --form-string 'url=https://example.com/article' \ --form-string 'format=markdown' ``` - `data.markdown`을 그대로 붙이고, 앞부분의 `# 제목`·`## 소제목`으로 문서 구조를 확인합니다. - `data.truncated`가 true이면 `max_chars`를 올려 다시 요청합니다. ## 사용 예시 2. 검색 색인용으로 본문·링크만 받기 본문 평문과 링크·이미지 목록만 있어 색인을 만들 때 씁니다. ```bash curl --fail-with-body --request POST 'https://apick.app/rest/url_to_markdown' \ --header "Authorization: Bearer $APICK_API_KEY" \ --form-string 'url=https://example.com/article' \ --form-string 'format=json' ``` - `data.json.text`를 색인 본문으로 쓰고 `data.word_count`로 길이를 확인합니다. - `data.json.links[]`·`data.json.images[]`는 같은 주소를 한 번만 담습니다. ## 코드·오류 ### 업무 실패 응답 입력 오류·대상 없음·일시 실패는 data.error(사유)와 data.success=0으로 오며 api.cost는 0(과금 없음)입니다. HTTP 상태는 400·404·408·424 중 하나입니다. 입력 오류는 값을 고쳐 다시 요청하고, 408·424는 잠시 후 한 번 다시 시도하세요. ```json { "data": { "error": "입력값을 확인해 주세요.", "success": 0 }, "api": { "success": true, "cost": 0, "ms": 5 } } ``` ## 상세 기능·요금 제공 정보 주소 하나를 보내면 메뉴·광고·각주를 걷어 낸 본문만 남깁니다. 자바스크립트로 나중에 표시되는 글도 결과에 포함됩니다. Markdown 은 문서 도구·위키에 바로 붙일 수 있고, JSON 은 제목 구조·링크·이미지·평문을 따로 담아 검색·색인에 쓰기 좋습니다. 본문 선택은 화면 구조를 기준으로 한 규칙 처리입니다. 사람이 읽는 요약·번역은 하지 않습니다. Method URL POST https://apick.app/rest/url_to_markdown ## 상세 요청 Header 이름 필수 설명 Authorization 필수 Bearer 인증키. 예: Authorization: Bearer 발급받은_API_키 ## 상세 응답 Body 필드 타입 설명 data Object 변환 결과 묶음입니다. 실패하면 아래 필드 대신 error 문구가 들어 있습니다. url String 실제로 연 주소입니다. 입력 주소가 다른 곳으로 넘겨졌으면 그 최종 주소입니다. title String 문서 제목입니다. 없으면 빈 문자열입니다. description String 문서 설명(요약 메타)입니다. 없으면 빈 문자열입니다. markdown String 본문을 옮긴 Markdown 입니다. format이 json이면 이 필드가 없습니다. json.headings Array 제목 구조입니다. 각 항목에 level(1~6)과 text가 들어 있습니다. json.text String Markdown 표기를 뺀 평문입니다. 검색 색인에 쓰기 좋습니다. json.links Array 본문 링크 목록입니다. 같은 주소는 한 번만 담고 text·href를 담습니다. json.images Array 본문 이미지 목록입니다. src와 alt를 담습니다. word_count Integer 본문 단어 수입니다. 공백 기준으로 셉니다. markdown_chars Integer Markdown 본문 글자 수입니다. truncated Boolean 본문이 max_chars를 넘어 잘렸으면 true입니다. error String 실패 사유 문구입니다. 정상 응답에는 없습니다. api Object 호출 공통 정보입니다. 처리 여부·차감 포인트·처리 시간·차감 기록 번호가 들어 있습니다. cost Integer 이번 호출에서 차감된 포인트입니다. data.error가 있는 실패 응답은 0입니다. ms Integer 요청을 받아 응답을 만들기까지 걸린 시간(밀리초)입니다. ## 상세 코드·정책 오류 응답 HTTP data.error 원인·조치 400 URL 형식이 올바르지 않습니다. 주소가 없거나 주소 형태가 아닙니다. http·https로 시작하는 전체 주소를 보내세요. 400 http 또는 https로 시작하는 주소만 사용할 수 있습니다. 다른 방식의 주소는 페이지를 열 수 없습니다. 400 이 호스트로는 요청할 수 없습니다. 내부망·루프백 주소입니다. 외부에 공개된 주소만 사용할 수 있습니다. 400 format 은 markdown·json·both 중 하나여야 합니다. 지원하지 않는 형식입니다. 셋 중 하나로 보내세요. 424 본문을 찾지 못했습니다. 다른 주소로 시도해 주세요. 페이지에 읽을 본문이 없습니다(이미지·스크립트만 있는 화면 등). 424 페이지를 열지 못했습니다. 주소와 접속 가능 여부를 확인해 주세요. 접속 실패·시간 초과입니다. 잠시 후 다시 시도하세요. 오류 응답은 data.success 0, api.cost 0이며 요금이 차감되지 않습니다. ## 상세 예제 요청 예시 form-data 전체 예제 보기 응답 예시 { "data": { "url": "https://example.com/article", "title": "기사 제목", "description": "기사 요약", "markdown": "# 기사 제목\n\n첫 문단입니다.\n\n- 항목 하나\n- 항목 둘", "json": { "headings": [{ "level": 1, "text": "기사 제목" }], "text": "기사 제목 첫 문단입니다. 항목 하나 항목 둘", "links": [{ "text": "자세히", "href": "https://example.com/more" }], "images": [{ "src": "https://example.com/a.png", "alt": "그림" }] }, "word_count": 18, "markdown_chars": 62, "truncated": false, "success": 1 }, "api": { "success": true, "cost": 15, "ms": 4321, "pl_id": 50232 } } 호출 예시 같은 요청을 JavaScript와 Python으로 옮긴 예시입니다. 키는 환경변수 APICK_API_KEY 에서 읽습니다. JavaScript 예시 form-data 전체 예제 보기 Python 예시 form-data 전체 예제 보기