특정 저자의 포스트만 반환합니다.

filter[author_id]

콘텐츠 타입으로 필터링합니다.

filter[content_type]

지정된 날짜 이후에 발행된 포스트만 반환합니다. (ISO 8601 형식)

filter[published_at_gte]

지정된 날짜 이전에 발행된 포스트만 반환합니다. (ISO 8601 형식)

filter[published_at_lte]

filter[published]

슬러그로 필터링합니다. 정확히 일치하는 포스트만 반환됩니다.

filter[slug]

특정 태그가 있는 포스트만 반환합니다.

filter[tag_id]

포함할 관련 리소스를 쉼표로 구분하여 지정

Posts에서 사용 가능한 값:
- `tags` - 포스트의 태그
- `authors` - 포스트의 저자


include

limit

order

page

sort

API 키 속성과 부여된 권한 범위입니다.

리소스 타입 식별자입니다. 항상 `api_keys`입니다.

생성할 저자 리소스 payload입니다.

블로그에서 사용할 수 있는 저자 리소스 목록입니다.

API가 반환하는 저자 필드입니다.

저자 표시 이름
- 블로그에 표시되는 이름
- 닉네임이나 필명 사용 가능


프로필 이미지 URL
- Inblog 스토리지에 업로드 권장
- 비율: 1:1 (정사각형)
- 권장 크기: 400x400px


리소스 타입 식별자
- JSON:API 표준에 따른 고정값
- 항상 "authors"


수정할 저자 리소스 payload입니다.

API가 반환하는 블로그 필드입니다.

블로그 언어 코드 (ISO 639-1)
- 기본값: ko (한국어)
- HTML lang 속성에 사용


파비콘 URL
- 크기: 32x32px 또는 64x64px
- ICO 또는 PNG 형식


블로그에 연결된 Google Analytics 4 측정 ID

로고 이미지 URL
- 권장 크기: 200x50px (가로형)
- 투명 배경 PNG 권장


로고 URL (deprecated, logo 사용 권장)

Open Graph 대표 이미지 URL
- SNS 공유 시 표시되는 이미지
- 권장 크기: 1200x630px


구독 플랜 (읽기 전용)
- free: 무료 플랜
- team: 팀 플랜
- enterprise: 엔터프라이즈 플랜


이 블로그에 연결된 Google Search Console 속성 URL

UTC 대비 시간차 (시간 단위)
- 한국: 9 (UTC+9)
- 일본: 9 (UTC+9)
- 미국 동부: -5 (UTC-5)


블로그 최종 수정 시간 (ISO 8601)

리소스 타입 식별자
- JSON:API 표준에 따른 고정값
- 항상 "blogs"


수정할 블로그 리소스 payload입니다.

헤더 네비게이션에 표시할 텍스트

배너 제목 아래에 표시할 보조 문구

블로그 하단에 표시할 푸터 텍스트

블로그 상단에 노출할 헤더 네비게이션 항목 목록

커스텀 UI 설정 업데이트를 위한 JSON:API 형식 payload입니다.

수정할 필드만 부분적으로 전달하면 해당 필드만 반영됩니다.

커스텀 도메인 추가를 위한 JSON:API 형식 payload입니다.

연결할 커스텀 도메인입니다. 프로토콜 없이 호스트명만 전달하세요.

블로그에 저장된 커스텀 도메인

Vercel 도메인 생성 응답 원문입니다. 도메인 상태에 따라 필드 구성이 달라질 수 있습니다.

현재 블로그에 커스텀 도메인이 설정되어 있는지 여부

Vercel 프로젝트 도메인 상태 조회 응답 원문

도메인이 아직 검증되지 않았을 때 반환되는 Vercel 검증 시도 응답 원문

블로그 레코드에 저장된 도메인 검증 상태

현재 페이지의 폼 리소스 목록입니다.

폼과 연결된 응답들 사이의 관계입니다.

이 폼에서 생성된 응답들과의 관계입니다.

리소스 타입 식별자입니다. 항상 `forms`입니다.

현재 페이지의 폼 응답 리소스 목록입니다.

응답 데이터(JSON 객체). 키는 폼 설정의 필드 라벨(dataLabel 또는 label)로 변환됩니다

응답과 연결된 폼, 포스트, 블로그 관계입니다.

이 폼 응답을 소유한 블로그와의 관계입니다.

이 응답을 수집한 폼과의 관계입니다.

폼이 삽입된 포스트와의 관계입니다. 존재할 때만 설정됩니다.

리소스 타입 식별자입니다. 항상 `form_responses`입니다.

모든 JSON:API 응답에 포함되는 JSON:API 버전 메타데이터입니다.

생성할 포스트 리소스 payload입니다.

현재 페이지의 포스트 리소스 목록입니다.

포스트 제목 (include=title 시 포함)

API가 반환하는 포스트의 주요 필드입니다.

"포스트 본문 HTML (TipTap 에디터로 생성)

**생성 방식:**

- Inblog는 TipTap 기반 WYSIWYG 에디터를 사용하여 HTML을 생성합니다

- 에디터에서 editor.getHTML() 메소드로 실시간 HTML 변환

- 모든 콘텐츠는 구조화된 블록 단위로 관리됩니다

**기본 HTML 태그:**

- 문단: `<p>`

- 제목: `<h2>`, `<h3>`, `<h4>` (h1, h5, h6는 미지원)

- 리스트: `<ul>`, `<ol>`, `<li>` (중첩 가능)

- 텍스트 스타일: `<strong>`, `<em>`, `<u>`, `<s>`, `<code>`

- 링크: `<a>` (rel 속성 없음, nofollow 제거)

- 인용: `<blockquote>`

- 구분선: `<hr>`

- 줄바꿈: `<br>`

**고급 포맷팅:**

- 하이라이트: `<mark>` (다중 색상 지원)
- 텍스트 색상: `<span style="color: #hex;">` 
- 텍스트 정렬: `style="text-align: left|center|right;"`
- 코드 블록: `<pre><code class="language-*">` (syntax highlighting 지원)

**테이블:**

- `<table>`, `<thead>`, `<tbody>`, `<tr>`, `<th>`, `<td>`
- 리사이즈 가능한 컬럼 (colwidth 속성)
- 가로 스크롤 자동 래핑

**커스텀 블록 (data-type 속성으로 구분):**

- 이미지: `<img data-type="imageBlock">` - 단일 이미지 블록
- 이미지 그리드: `<div data-type="imageGrid">` - 그리드 레이아웃
- 이미지 캐러셀: `<div data-type="imageCarousel">` - 슬라이드 형식
- 콜아웃: `<div data-type="callOut">` - 강조 박스
- 링크 버튼: `<div data-type="linkButton">` - CTA 버튼
- 북마크: `<div data-type="bookmark">` - URL 프리뷰

**임베드 지원:**

- YouTube: `<div data-type="youtube" data-youtube-video-id="*">`
- 폼 서비스:
  - Google Forms: `<div data-type="googleForm">`
  - HubSpot: `<div data-type="hubspot">`
  - Tally: `<div data-type="tally">`
  - Typeform: `<div data-type="typeform">`
- HTML 코드 블록: `<section data-type="code-block"><div>...</div></section>` - 커스텀 HTML 삽입 (iframe 등). 반드시 `section` 태그 + `data-type="code-block"` + 내부 `<div>` 래퍼 형식이어야 tiptap 스키마에 매칭됨. `<div data-type="htmlCodeBlock">` 형식은 동작하지 않음

**보안 및 제한사항:**

- `<script>` 태그는 자동 제거됨 (XSS 방지)
- 이미지는 Inblog CDN (source.inblog.dev) 사용 권장
- 외부 스타일시트 링크 제한
- iframe은 허용된 임베드 서비스만 가능

**예시:**

```html
<h2>제목</h2>
<p>일반 텍스트와 <strong>강조</strong>, <em>이탤릭</em></p>
<div data-type="imageBlock" data-width="wide">
  <img src="https://source.inblog.dev/..." alt="설명">
</div>
<div data-type="callOut" data-emoji="💡">
  <p>중요한 정보입니다</p>
</div>
<pre><code class="language-javascript">console.log('Hello');</code></pre>
```\n"


CTA 버튼 배경색 (hex color)
- 6자리 hex 코드 (#RRGGBB)
- 기본값: 블로그 테마 색상


CTA 버튼 배경색 타입
- custom: cta_color에 지정된 커스텀 색상 사용
- preset: 블로그 프리셋 색상 사용
- default: 블로그 테마 색상 사용


CTA 버튼 텍스트 색상 (hex color)
- 6자리 hex 코드 (#RRGGBB)
- 기본값: #ffffff (흰색)


CTA 버튼 텍스트 색상 타입
- custom: cta_text_color에 지정된 커스텀 색상 사용
- default: 버튼 배경색 대비로 자동 계산 (#ffffff 또는 #000000)
- 이 필드 없이 cta_text_color만 보내면 커스텀 색상이 에디터에서 덮어씌워질 수 있음


포스트에 삽입되는 커스텀 스크립트

포스트 요약 설명 (SEO meta description)

포스트에 연결할 폼 ID. null로 설정하면 폼을 제거합니다.

SEO용 메타 설명 (검색 결과에 표시)

SEO용 메타 제목 (브라우저 탭에 표시)

포스트 발행 시간 (ISO 8601 형식)

URL 친화적인 고유 식별자. 영문, 숫자, 하이픈만 허용

포스트 제목 (SEO를 위해 60자 이내 권장)

포스트와 연결된 태그 및 저자 관계입니다.

리소스 타입 식별자
- JSON:API 표준에 따른 고정값
- 항상 "posts"


포스트와 함께 포함된 태그, 저자 등의 관련 리소스입니다.

수정할 포스트 리소스 payload입니다.

생성할 리다이렉트 리소스 payload입니다.

현재 블로그의 리다이렉트 규칙 리소스 목록입니다.

API가 반환하는 리다이렉트 규칙 필드입니다.

원본 경로 (리다이렉트 대상)
- 반드시 /로 시작
- 중복 불가
- 와일드카드 미지원


리다이렉트 타입
- 307: 임시 리다이렉트 (Temporary Redirect)
- 308: 영구 리다이렉트 (Permanent Redirect)


대상 경로 (리다이렉트 목적지)
- 반드시 /로 시작
- 외부 URL도 가능 (http:// 또는 https://)


리소스 타입 식별자
- JSON:API 표준에 따른 고정값
- 항상 "redirects"


수정할 리다이렉트 리소스 payload입니다.

연관 리소스 식별자, 리소스 식별자 배열, 또는 `null`입니다.

리소스 ID (필수)
- 문자열 형식
- 해당 타입 내에서 고유해야 함

**중요:** 아래 예시 값(123)은 샘플입니다. 실제 사용 시:
- Tag ID 조회: `GET /v1/tags`
- Author ID 조회: `GET /v1/authors`

존재하지 않는 ID 사용 시 400 에러가 발생합니다.


리소스 타입 (필수)
- posts, tags, authors 등


OAuth 흐름에서 사용한 리다이렉트 URI입니다. 생략하면 기본 대시보드 콜백을 사용합니다.

서치콘솔이 현재 연결되었는지 여부

토큰 교환 및 저장 작업 성공 여부

작업 후에도 서치콘솔이 연결 상태인지 여부

서치콘솔이 현재 연결되어 있는지 여부

연결된 Search Console 속성 URL입니다. 연결되지 않았으면 `null`입니다.

생성할 태그 리소스 payload입니다.

현재 블로그의 태그 리소스 목록입니다.

API가 반환하는 태그 필드입니다.

태그 이름 (대소문자 구분, 중복 불가)

URL 친화적인 고유 식별자
- 영문 소문자, 숫자, 하이픈만 허용
- 자동으로 name에서 생성 가능


리소스 타입 식별자
- JSON:API 표준에 따른 고정값
- 항상 "tags"


수정할 태그 리소스 payload입니다.

날짜 또는 시간 (집계 단위에 따라 다름)

현재 사용자가 접근 가능한 블로그 리소스 목록입니다.

인증된 사용자가 확인할 수 있는 블로그 속성입니다.

현재 사용자가 이 블로그에서 글을 발행할 수 있는지 여부

문자열로 직렬화된 블로그 숫자 ID

리소스 타입 식별자. 항상 `blogs`입니다.

API 키를 Bearer 토큰으로 사용합니다.

형식: `Authorization: Bearer YOUR_API_KEY`

API 키는 Inblog 대시보드에서 생성할 수 있습니다.


서명된 사용자 JWT를 Bearer 토큰으로 사용합니다.

형식: `Authorization: Bearer USER_JWT`

`/user/blogs` 같은 사용자 단위 엔드포인트에서 사용합니다.


Inblog Support

Inblog API를 사용하여 블로그 콘텐츠를 관리할 수 있습니다.

## 🚀 Getting Started

### 1. API 키 발급
대시보드에서 API 키를 발급받으세요:
1. [Inblog 대시보드](https://inblog.ai/dashboard)에 로그인
2. 설정 → API 키 메뉴로 이동
3. "새 API 키 생성" 버튼 클릭
4. 필요한 권한 범위(scopes) 선택
5. 생성된 API 키 안전하게 보관

### 2. 첫 번째 요청
```bash
curl -X GET https://api.inblog.ai/api/v1/me \
  -H "Authorization: Bearer YOUR_API_KEY"
```

### 3. npm 개발자 도구 사용
API를 직접 호출하지 않아도 CLI와 AI Skills로 블로그 콘텐츠를 관리할 수 있습니다.
```bash
npm install -g @inblog/cli
inblog auth login
```
AI 코딩 도구에서 인블로그를 사용하려면 AI Skills를 설치하세요:
```bash
npx @inblog/ai-skills
```
CLI는 터미널에서 포스트, 이미지, 태그, 저자, 리다이렉트, 폼, 분석, 블로그 설정을 관리합니다. AI Skills는 Codex, Claude Code, Cursor, GitHub Copilot, Gemini 같은 도구에 인블로그 워크플로우를 설치합니다.
자세한 사용법은 [개발자 도구 가이드](/ko/docs/developer-tools/inblog-cli-and-ai-skills)를 참고하세요.

### 4. Content-Type
- **요청**: `Content-Type: application/json` 또는 `application/vnd.api+json`
- **응답**: `Content-Type: application/vnd.api+json`

## 📋 주요 기능

- **포스트 관리**: 작성, 수정, 삭제, 발행
- **태그와 저자**: 분류 및 저자 정보 관리
- **블로그 설정**: 기본 설정 변경
- **URL 리다이렉트**: 307(임시)/308(영구) 리다이렉트 설정
- **폼 및 응답**: 리드 캡처 폼 및 제출 데이터 조회
- **JSON:API 표준**: 일관된 응답 형식

## 🔐 인증

모든 API 요청에는 Authorization Header를 통한 Bearer 토큰 인증이 필요합니다:

```
Authorization: Bearer YOUR_API_KEY
```
## 📚 더 알아보기

- [JSON:API 스펙](https://jsonapi.org/)

Proprietary

Inblog API

블로그에 등록된 모든 저자 프로필을 조회합니다.

해당 저자와 이 블로그 포스트 간의 연결을 제거합니다. 프로필 자체를 삭제하지는 않습니다.


특정 저자의 프로필 정보를 조회합니다.

저자의 프로필 정보를 수정합니다.

**수정 가능한 필드:**
- author_name: 저자 표시 이름
- avatar_url: 프로필 이미지 URL

**이미지 처리:**
프로필 이미지 URL은 기본적으로 Inblog R2 스토리지로 업로드됩니다.
원본 URL을 유지하려면 `preserve_external_images=true` 쿼리 파라미터를 사용하세요.


외부 이미지 URL을 R2 스토리지로 업로드하지 않고 원본을 유지합니다

preserve_external_images

PATCH와 동일하게 저자 정보를 수정합니다. 현재 구현에서는 PUT과 PATCH가 같은 동작을 수행합니다.


각 포스트의 방문, 클릭, 오가닉, CVR 등 성과 지표를 조회합니다.
include 파라미터에 "title"을 설정하면 포스트 제목도 함께 반환됩니다.


start_date

end_date

추가 포함 데이터 ("title" 설정 시 포스트 제목 포함)

특정 포스트의 트래픽 데이터를 시계열로 조회합니다.


interval

포스트 트래픽 데이터 조회 성공

특정 포스트의 유입 소스(리퍼러) 데이터를 조회합니다.


포스트 유입 소스 데이터 조회 성공

블로그 전체의 유입 소스(리퍼러) 데이터를 조회합니다.


블로그 전체의 트래픽 데이터를 일별 또는 시간별로 조회합니다.
페이지 유형(전체, 홈, 포스트, 카테고리, 저자)별로 필터링할 수 있습니다.


type

블로그의 현재 배너 및 UI 커스터마이징 설정을 조회합니다.


블로그의 배너 및 UI 커스터마이징 설정을 업데이트합니다.
일부 필드만 전송하여 부분 업데이트가 가능합니다.


블로그에 설정된 커스텀 도메인을 제거합니다.


현재 설정된 커스텀 도메인의 DNS 설정 및 검증 상태를 확인합니다.


블로그에 커스텀 도메인을 추가합니다.
도메인 추가 후 DNS 설정 안내와 검증 상태가 반환됩니다.


현재 API 키에 연결된 블로그의 정보를 조회합니다.

블로그 이름, 설명, 로고, 파비콘, 대표 이미지 등 기본 설정을 수정합니다.

**이미지 처리:**
로고, 파비콘, 대표 이미지 URL은 기본적으로 Inblog R2 스토리지로 업로드됩니다.
원본 URL을 유지하려면 `preserve_external_images=true` 쿼리 파라미터를 사용하세요.


블로그 이름, 설명, 로고, 파비콘, 대표 이미지 등 기본 설정을 PUT으로 수정합니다.

**이미지 처리:**
로고, 파비콘, 대표 이미지 URL은 기본적으로 Inblog R2 스토리지로 업로드됩니다.
원본 URL을 유지하려면 `preserve_external_images=true` 쿼리 파라미터를 사용하세요.


OAuth authorization code를 토큰으로 교환하여 서치콘솔 연결을 완료합니다.


Google Search Console 연결을 해제합니다.


Google Search Console에서 키워드별 검색 성과 데이터를 조회합니다.
클릭, 노출, CTR, 평균 순위 등의 지표를 확인할 수 있습니다.


조회 시작일 (YYYY-MM-DD, 기본: 28일 전)

조회 종료일 (YYYY-MM-DD, 기본: 오늘)

Google Search Console 연결을 위한 OAuth 인증 URL을 생성합니다.
선택적으로 CLI 콜백용 redirect_uri를 지정할 수 있습니다.


redirect_uri

Google Search Console에서 페이지별 검색 성과 데이터를 조회합니다.
키워드 성과와 동일한 파라미터 및 응답 구조를 사용합니다.


페이지별 검색 성과 데이터 조회 성공

페이지별 검색 성과 데이터 조회

Google Search Console의 현재 연결 상태를 확인합니다.


블로그의 폼 응답 목록을 페이지네이션으로 조회합니다. `form_id`로 필터링할 수 있으며, 각 응답에는 관련 폼, 게시물, 블로그의 relationship identifier가 포함됩니다.

form_id

ID로 특정 폼 응답의 상세 정보를 가져옵니다.

블로그의 폼 목록을 페이지네이션으로 조회합니다. 각 폼에는 현재 누적 응답 개수가 포함됩니다.

ID로 특정 폼의 상세 정보를 가져옵니다.

현재 사용 중인 API 키의 정보와 권한을 조회합니다.

연결된 블로그와 보유한 권한 목록을 확인할 수 있습니다.


블로그에 발행된 포스트 목록을 가져옵니다.
페이지 번호와 개수를 지정할 수 있고, 태그나 저자 정보도 함께 가져올 수 있습니다.


새로운 포스트를 생성합니다.

**필수 필드:**
- title: 포스트 제목
- slug: URL 슬러그 (블로그 내에서 고유해야 함)

**이미지 처리:**
외부 이미지 URL이 제공되면 기본적으로 인블로그 R2 스토리지로 업로드됩니다.
원본 URL을 유지하려면 `preserve_external_images=true` 쿼리 파라미터를 사용하세요.

**제한사항:**
- id 필드는 허용되지 않습니다. 포스트 ID는 서버에서 자동 생성됩니다.
- 기존 포스트를 수정하려면 PATCH /posts/{id}를 사용하세요.

**응답 코드:**
- 201: 포스트가 성공적으로 생성됨
- 400: 잘못된 요청 (예: id 필드 포함)
- 409: slug가 이미 존재함

외부 이미지 URL을 제공하면 자동으로 Inblog 스토리지에 저장됩니다.


포스트를 완전히 삭제합니다. 이 작업은 되돌릴 수 없습니다.


포스트 ID로 특정 포스트의 상세 정보를 가져올 수 있습니다.

이미 작성한 포스트의 내용과 설정을 수정할 수 있습니다.

**이미지 처리:**
외부 이미지 URL이 제공되면 기본적으로 인블로그 R2 스토리지로 업로드됩니다.
원본 URL을 유지하려면 `preserve_external_images=true` 쿼리 파라미터를 사용하세요.


PATCH와 동일하게 포스트를 수정합니다. 현재 구현에서는 PUT과 PATCH가 같은 동작을 수행합니다.


포스트에 연결된 저자 목록을 조회합니다.

포스트의 모든 저자를 새로운 저자 세트로 교체합니다.
기존 저자는 모두 제거되고 새로 지정한 저자만 남습니다.


포스트에 하나 이상의 저자를 추가합니다.
이미 연결된 저자는 자동으로 건너뜁니다.


포스트에서 특정 저자를 제거합니다.

authorId

포스트를 즉시 발행하거나 예약 발행할 수 있습니다.

**지원되는 액션**:
- `publish` - 즉시 발행
- `unpublish` - 발행 취소
- `schedule` - 예약 발행 (미래 시간만 가능)


포스트에 연결된 태그 목록을 조회합니다.

포스트의 모든 태그를 새로운 태그 세트로 교체합니다.
기존 태그는 모두 제거되고 새로 지정한 태그만 남습니다.


포스트에 하나 이상의 태그를 추가합니다.
이미 연결된 태그는 자동으로 건너뜁니다.


포스트에서 특정 태그를 제거합니다.

tagId

블로그에 설정된 모든 URL 리다이렉트 규칙을 조회합니다.

새로운 리다이렉트 규칙을 생성합니다.
**필수 필드:** - from_path: 리다이렉트 원본 경로 - to_path: 리다이렉트 대상 경로
**응답 코드:** - 201: 리다이렉트 생성 성공 - 409: from_path가 이미 존재함


리다이렉트 규칙을 영구 삭제합니다. ⚠️ 이 작업은 되돌릴 수 없습니다!

특정 리다이렉트 규칙의 상세 정보를 조회합니다.

리다이렉트 규칙을 수정합니다.

PUT으로 리다이렉트 규칙을 수정합니다. 현재 구현에서는 PUT과 PATCH가 동일하게 동작합니다.

블로그에 등록된 모든 태그를 조회합니다.

새로운 태그를 생성합니다.

**필수 필드:**
- name: 태그 이름
- slug: URL 슬러그 (블로그 내에서 고유해야 함)

**응답 코드:**
- 201: 태그 생성 성공
- 409: slug가 이미 존재함


태그를 삭제합니다. 연결된 post-tag 관계는 함께 제거됩니다.


태그 ID로 특정 태그의 상세 정보를 가져옵니다.

태그의 이름이나 기타 정보를 수정합니다.

PATCH와 동일하게 태그를 수정합니다. 현재 구현에서는 PUT과 PATCH가 같은 동작을 수행합니다.


이미지를 업로드하고 공개 URL을 반환합니다.

**요청 방식:**
- `fileKey` 쿼리 파라미터로 저장 키를 전달합니다.
- 요청 본문에는 파일 바이너리를 그대로 전송합니다.
- 허용 MIME 타입: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/svg+xml`, `image/x-icon`

**제한사항:**
- 최대 파일 크기: 10MB
- 업로드 rate limit이 적용됩니다.


업로드 파일 키. 예: `post-image/2026-04-02T10:00:00.000Z-uuid`

fileKey

현재 로그인한 사용자가 접근 가능한 블로그 목록과 권한 정보를 조회합니다.


내가 접근 가능한 블로그 목록 조회