返却するポストのフィールドをカンマ区切りで指定します。不明な名前は無視されます。既定で除外される本文が必要な場合は content_html を含めてください。

fields[posts]

指定した作成者による投稿のみを返します。

filter[author_id]

コンテンツタイプでフィルタリングします。

filter[content_type]

この日付以降に公開された投稿のみを返します。（ISO 8601 形式）

filter[published_at_gte]

この日付以前に公開された投稿のみを返します。（ISO 8601 形式）

filter[published_at_lte]

公開ステータスでフィルタリングします。

filter[published]

slug でフィルタリングします。完全に一致する投稿のみを返します。

filter[slug]

指定したタグを持つ投稿のみを返します。

filter[tag_id]

含める関連リソースをカンマ区切りで指定します

Posts で利用可能な値:
- `tags` - 投稿のタグ
- `authors` - 投稿の作成者


include

1 ページあたりの件数 JSON:API 形式の `page[size]` も受け付けます。

limit

order

ページ番号（1 から開始） JSON:API 形式の `page[number]` も受け付けます。

page

sort

API key の属性と付与されたスコープ。

API key に付与された権限のリスト

接続されているブログのサブドメイン

リソースタイプ識別子。常に `api_keys`。

作成する著者のリソースペイロード。

ブログで利用可能な著者リソース。

著者の表示名
- ブログ上に表示される名前
- ニックネームやペンネームも使用可能


プロフィール画像URL
- Inblogストレージへのアップロードを推奨
- 比率: 1:1（正方形）
- 推奨サイズ: 400x400px


リソースタイプ識別子
- JSON:API標準に従った固定値
- 常に "authors"


更新する著者のリソースペイロード。

ブログの言語コード (ISO 639-1)
- デフォルト: ko (韓国語)
- HTML の lang 属性で使用されます


カスタムドメインの検証ステータス

ファビコン URL
- サイズ: 32x32px または 64x64px
- ICO または PNG 形式


ブログに接続されている Google Analytics 4 の測定 ID

Google Search Console が現在接続されているかどうか

ロゴ画像URL
- 推奨サイズ: 200x50px（横長）
- 透過背景のPNGを推奨


ロゴ URL (非推奨。代わりに logo を使用してください)

Open Graph アイキャッチ画像 URL
- ソーシャルメディアでの共有時に表示される画像
- 推奨サイズ: 1200x630px


サブスクリプションプラン (読み取り専用)
- free: Free プラン
- team: Team プラン
- enterprise: Enterprise プラン


このブログにリンクされている Google Search Console のプロパティ URL

UTC との時差 (時間単位)
- 韓国: 9 (UTC+9)
- 日本: 9 (UTC+9)
- 米国東部: -5 (UTC-5)


ブログの最終更新日時 (ISO 8601)

リソースタイプ識別子
- JSON:API標準に従った固定値
- 常に "blogs"


更新するブログリソースのペイロード。

ヘッダーナビゲーション項目に表示されるテキスト

ナビゲーション項目をクリックしたときに開く遷移先 URL

バナータイトルの下に表示される補足テキスト

バナーに表示される見出しテキスト

16進数形式のバナータイトルの色

ブログ下部に表示されるフッターテキスト

ブログ上部に表示されるヘッダーナビゲーション項目

カスタム UI 設定を更新するための JSON:API 形式のペイロード。

更新するフィールドを任意の組み合わせで指定します。指定されたフィールドのみが変更されます。

カスタムドメインを追加するための JSON:API スタイルのペイロード。

接続するカスタムドメイン。プロトコルを付けず、ホスト名のみを指定してください。

ブログに保存されたカスタムドメイン

Vercel のドメイン作成レスポンスの生データ。フィールドの構成は、現在の Vercel ドメインの状態によって異なります。

ドメインに対して保存された初期の検証ステータス

カスタムドメインが正常に削除されたかどうか

ブログに現在カスタムドメインが設定されているかどうか

現在設定されているカスタムドメイン

Vercel のプロジェクトドメインステータスレスポンスの生データ

ドメインがまだ検証されていない場合に返される、Vercel の検証試行レスポンスの生データ

ブログレコードに保存されている検証ステータス

JSON:API エラーオブジェクトのリスト。

現在のページのフォームリソース。

API が返すフォームフィールド。

フォーム作成時刻（ISO 8601 形式）

リードマグネットのファイルソース

リードマグネットのダウンロードURL

フォームから、送信されたレスポンスへのリレーションシップ。

このフォームから作成されたフォームレスポンスへのリレーションシップ。

リソースタイプ識別子。常に `forms`。

現在のページのフォームレスポンスリソース。

送信されたフォームレスポンスのフィールド。

レスポンス送信時刻（ISO 8601 形式）

レスポンスデータ（JSON オブジェクト）。キーはフォームフィールドのラベル（dataLabel または label）に解決されます

関連するフォーム、ポスト、ブログへのリレーションシップ。

フォームレスポンスを所有するブログへのリレーションシップ。

このレスポンスを収集したフォームへのリレーションシップ。

フォームが埋め込まれていたポストへのリレーションシップ（利用可能な場合）。

リソースタイプ識別子。常に `form_responses`。

すべての JSON:API レスポンスに含まれる JSON:API バージョンのメタデータ。

実装されている JSON:API バージョン。

コールバックに使用される Redirect URI

作成する投稿リソースのペイロード。

現在のページの投稿リソース。

オーガニック検索による訪問数

投稿タイトル（include=title のときに含まれます）

指定された期間の投稿ごとのトラフィック指標行。

API が返す投稿の主要フィールド。

正規URL（重複コンテンツ防止用）

"投稿コンテンツ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-*">`（シンタックスハイライト対応）

**テーブル:**

- `<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など）。tiptapスキーマに合わせるには `section` タグ + `data-type="code-block"` + 内側の `<div>` ラッパーを使用する必要があります。`<div data-type="htmlCodeBlock">` は機能しません

**セキュリティと制限事項:**

- `<script>` タグは自動的に削除されます（XSS対策）
- 画像にはInblog CDN（source.inblog.dev）を使用してください
- 外部スタイルシートリンクは制限されています
- iframeは許可された埋め込みサービスに対してのみ許可されます

**例:**

```html
<h2>Title</h2>
<p>Regular text with <strong>emphasis</strong>, <em>italic</em></p>
<div data-type="imageBlock" data-width="wide">
  <img src="https://source.inblog.dev/..." alt="Description">
</div>
<div data-type="callOut" data-emoji="💡">
  <p>Important information</p>
</div>
<pre><code class="language-javascript">console.log('Hello');</code></pre>
```\n"


CTAボタンの背景色（16進カラー）
- 6桁の16進コード（#RRGGBB）
- デフォルト: ブログのテーマカラー


CTAボタンの背景色タイプ
- custom: cta_color で指定したカスタムカラーを使用
- preset: ブログのプリセットカラーを使用
- default: ブログのテーマカラーを使用


CTAボタンをクリックしたときに遷移するURL

CTAボタンのテキストカラー（16進カラー）
- 6桁の16進コード（#RRGGBB）
- デフォルト: #ffffff（白）


CTAボタンのテキストカラータイプ
- custom: cta_text_color で指定したカスタムカラーを使用
- default: ボタン背景とのコントラストから自動計算（#ffffff または #000000）
- これを 'custom' に設定せずに cta_text_color を送信すると、エディタによって色が上書きされる場合があります


投稿に挿入されるカスタムスクリプト

投稿の要約説明（SEOメタディスクリプション）

投稿に添付するForm ID。フォームを削除するには null を設定します。

SEOメタディスクリプション（検索結果に表示）

SEOメタタイトル（ブラウザタブに表示）

投稿の公開日時（ISO 8601形式）

URLに適した一意の識別子。使用できるのは英字、数字、ハイフンのみ

投稿タイトル（SEOのため60文字未満を推奨）

投稿からタグおよび著者へのリレーションシップ。

リソースタイプ識別子
- JSON:API 標準に従った固定値
- 常に "posts"


タグや著者など、投稿とともに含まれる関連リソース。

単一の投稿のトラフィック時系列行。

更新する投稿のリソースペイロード。

公開アクションのペイロード。

作成するリダイレクトリソースのペイロード。

現在のブログのリダイレクトルールリソース。

API が返すリダイレクトルールのフィールド。

ソースパス (リダイレクト元)
- / で始まる必要があります
- 一意である必要があります
- ワイルドカードはサポートされていません


リダイレクトタイプ
- 307: Temporary Redirect
- 308: Permanent Redirect


ターゲットパス (リダイレクト先)
- / で始まる必要があります
- 外部 URL も使用できます (http:// または https://)


リソースタイプ識別子
- JSON:API 標準に従った固定値
- 常に "redirects"


更新するリダイレクトのリソースペイロード。

訪問数で順位付けされたリファラー行。

リファラーのドメインまたはソース

関連リソース識別子、リソース識別子の配列、または `null`。

リソース ID（必須）
- 文字列形式
- そのタイプ内で一意である必要があります

**重要:** 例の値（123）はサンプルです。実際に使用する場合:
- Tag ID の取得: `GET /v1/tags`
- Author ID の取得: `GET /v1/authors`

存在しない ID を使用すると 400 エラーになります。


リソースタイプ（必須）
- posts、tags、authors など。


Google から返された OAuth 認可コード

OAuth フローで使用される Redirect URI。省略すると、デフォルトのダッシュボードコールバックが使用されます。

Search Console が現在接続されているかどうか

トークン交換と保存処理が成功したかどうか

操作の完了後も Search Console が接続されたままかどうか

接続解除処理が成功したかどうか

接続されている Search Console プロパティの URL。接続されていない場合は `null` を返します。

指定された期間の Search Console パフォーマンス行。

作成する Tag リソースのペイロード。

現在のブログの Tag リソース。

タグ名 (大文字・小文字を区別し、一意である必要があります)

URL に適した一意の識別子
- 小文字の英字、数字、ハイフンのみ使用可能
- name から自動生成できます


リソースタイプ識別子
- JSON:API 標準に従う固定値
- 常に "tags"


更新する Tag リソースのペイロード。

指定された期間のトラフィック時系列行。

データポイントの日付または日時

アップロードされたアセットの公開 URL

現在のユーザーがアクセスできるブログリソース。

認証されたユーザーが参照できるブログの属性。

ブログに設定されている主要言語

現在のユーザーがこのブログで投稿を公開できるかどうか

設定されている場合、接続されているカスタムドメイン

ブログに対する現在のユーザーの権限

ブログの現在のサブスクリプションプラン

文字列としてシリアライズされた数値のブログ ID

リソースタイプ識別子。常に `blogs`。

API キーを Bearer トークンとして使用します。

形式: `Authorization: Bearer YOUR_API_KEY`

API キーは inblog ダッシュボードから生成できます。


署名済みのユーザー JWT を Bearer トークンとして使用します。

形式: `Authorization: Bearer USER_JWT`

このスキームは `/user/blogs` などのユーザースコープのエンドポイントで使用されます。


Inblog Support

Inblog API を使ってブログコンテンツを管理します。

## 🚀 はじめに

### 1. API キーを取得する
ダッシュボードから API キーを取得します:
1. [Inblog Dashboard](https://inblog.ai/dashboard) にログインします
2. Settings → API Keys に移動します
3. "Create New API Key" ボタンをクリックします
4. 必要な権限スコープを選択します
5. API キーを安全に保管します

### 2. 最初のリクエスト
```bash
curl -X GET https://api.inblog.ai/api/v1/me \
  -H "Authorization: Bearer YOUR_API_KEY"
```

### 3. npm 開発者ツールを使う
手動で API を呼び出したくない場合は、CLI をインストールします:
```bash
npm install -g @inblog/cli
inblog auth login
```
AI コーディングアシスタント向けには、AI Skills をインストールします:
```bash
npx @inblog/ai-skills
```
CLI を使うと、ターミナルから posts、images、tags、authors、redirects、forms、analytics、ブログ設定を管理できます。AI Skills は Codex、Claude Code、Cursor、GitHub Copilot、Gemini などのツール向けに Inblog ワークフローをインストールします。
[Developer Tools guide](/docs/developer-tools/inblog-cli-and-ai-skills) をお読みください。

### 4. Content-Type
- **Request**: `Content-Type: application/json` または `application/vnd.api+json`
- **Response**: `Content-Type: application/vnd.api+json`

## 📋 主な機能

- **Post Management**: 投稿の作成、更新、削除、公開
- **Tags and Authors**: カテゴリと著者情報の管理
- **Blog Settings**: 基本設定の変更
- **URL Redirects**: 307 (一時的) および 308 (恒久的) リダイレクトの設定
- **Forms & Responses**: リード獲得フォームと送信データの閲覧
- **JSON:API Standard**: 一貫したレスポンス形式

## 🔐 認証

すべての API リクエストには、Authorization ヘッダーによる Bearer トークン認証が必要です:

```
Authorization: Bearer YOUR_API_KEY
```
## 📚 さらに詳しく

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

Proprietary

Inblog API

ブログに登録されているすべての著者プロフィールを取得します。

著者リストの取得に成功しました

このブログの投稿から著者の関連付けを削除します。著者プロフィール自体は削除されません。

特定の著者のプロフィール情報を取得します。

著者のプロフィール情報を更新します。

**編集可能なフィールド:**
- author_name: 著者の表示名
- avatar_url: プロフィール画像URL

**画像処理:**
プロフィール画像URLはデフォルトで inblog の R2 ストレージにアップロードされます。
元のURLを保持するには、`preserve_external_images=true` クエリパラメータを使用してください。


R2 ストレージにアップロードする代わりに、外部画像URLを保持します

preserve_external_images

PUT を使用して著者のプロフィール情報を更新します。

**編集可能なフィールド:**
- author_name: 著者の表示名
- avatar_url: プロフィール画像URL

**画像処理:**
プロフィール画像URLはデフォルトで inblog の R2 ストレージにアップロードされます。
元のURLを保持するには、`preserve_external_images=true` クエリパラメータを使用してください。


訪問数、クリック数、オーガニックトラフィック、コンバージョン率を含む投稿ごとのパフォーマンス指標を取得します。

開始日（YYYY-MM-DD）。デフォルトは28日前です。

start_date

終了日（YYYY-MM-DD）。デフォルトは本日です。

end_date

結果を並べ替える対象のフィールド

レスポンスに投稿タイトルを含めるには "title" を指定します

投稿指標を正常に取得しました

投稿パフォーマンス指標の取得

特定の投稿について、日次または時間単位の粒度で経時的なトラフィックデータを取得します。

interval

投稿トラフィックデータを正常に取得しました

特定の投稿について、リファラーデータを示すトラフィックソース分析を取得します。

投稿トラフィックソースを正常に取得しました

投稿トラフィックソースを取得

訪問数で並べ替えたリファラーデータを示すトラフィックソース分析を取得します。

トラフィックソースを正常に取得しました

ブログ全体のトラフィックデータを日次または時間単位の粒度で取得します。visits、clicks、オーガニックトラフィック、ページタイプ別の内訳を含みます。

ページタイプでフィルタリング

type

トラフィックデータが正常に取得されました

ブログの現在のバナーと UI カスタマイズ設定を取得します。

バナーとUIのカスタマイズ設定を更新します。指定したフィールドのみが更新されます。

UI設定が正常に更新されました

ブログからカスタムドメインを削除します。ブログはデフォルトのサブドメインに戻ります。

カスタムドメインを正常に削除しました

現在のカスタムドメイン構成と DNS 検証ステータスを確認します。

ドメインステータスを正常に取得しました

ブログにカスタムドメインを追加します。検証に必要な Vercel DNS 設定を含むドメイン構成を返します。

カスタムドメインを正常に追加しました

現在の API key に接続されているブログの情報を取得します。

ブログ名、説明、ロゴ、ファビコン、アイキャッチ画像などの基本設定を更新します。

**画像処理:**
ロゴ、ファビコン、アイキャッチ画像のURLはデフォルトで inblog の R2 ストレージにアップロードされます。
元のURLを保持するには、`preserve_external_images=true` クエリパラメータを使用してください。
