Comma-separated post fields to return. Unknown names are ignored. Include content_html to request the post body, which is omitted by default.

fields[posts]

Return only posts by the specified author.

filter[author_id]

filter[content_type]

Return only posts published on or after this date. (ISO 8601 format)

filter[published_at_gte]

Return only posts published on or before this date. (ISO 8601 format)

filter[published_at_lte]

filter[published]

Filter by slug. Returns only posts with an exact match.

filter[slug]

Return only posts with the specified tag.

filter[tag_id]

Specify related resources to include, separated by commas

Available values for Posts:
- `tags` - Post tags
- `authors` - Post authors


include

Items per page JSON:API style `page[size]` is also accepted.

limit

order

Page number (starting from 1) JSON:API style `page[number]` is also accepted.

page

sort

Resource type identifier. Always `api_keys`.

Author display name
- Name displayed on the blog
- Can use nickname or pen name


Profile image URL
- Recommended to upload to Inblog storage
- Ratio: 1:1 (square)
- Recommended size: 400x400px


Resource type identifier
- Fixed value according to JSON:API standard
- Always "authors"


Blog language code (ISO 639-1)
- Default: ko (Korean)
- Used in HTML lang attribute


Favicon URL
- Size: 32x32px or 64x64px
- ICO or PNG format


Google Analytics 4 measurement ID connected to the blog

Whether Google Search Console is currently connected

Logo image URL
- Recommended size: 200x50px (landscape)
- Transparent background PNG recommended


Open Graph featured image URL
- Image displayed when sharing on social media
- Recommended size: 1200x630px


Subscription plan (read-only)
- free: Free plan
- team: Team plan
- enterprise: Enterprise plan


Google Search Console property URL linked to this blog

Time difference from UTC (in hours)
- Korea: 9 (UTC+9)
- Japan: 9 (UTC+9)
- US Eastern: -5 (UTC-5)


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


Destination URL opened when the navigation item is clicked

Banner background color in hexadecimal format

Supporting text shown below the banner title

Footer text displayed at the bottom of the blog

Header navigation items shown at the top of the blog

JSON:API-style payload for updating custom UI settings.

Provide any subset of fields to update. Only included fields will be modified.

Custom design code fields. Each field is null when not set.

Handlebars template for the blog banner area

Handlebars template for the blog page layout

Resource type identifier. Always `blog_design_code`.

Design code field the code is intended for

Validation result. Compile-level only — partials and helper calls without arguments can still fail at render time.

Compile errors. Empty when the code is valid.

JSON:API-style payload for adding a custom domain.

Custom domain to connect. Provide the hostname only, without protocol.

Raw Vercel domain creation response. The exact field set varies depending on the current Vercel domain state.

Initial verification state saved for the domain

Whether the custom domain was removed successfully

Whether a custom domain is currently configured for the blog

Raw Vercel project-domain status response

Raw Vercel verification attempt response returned when the domain is not yet verified

Verification state stored on the blog record

Relationships from the form to its submitted responses.

Relationship to the form responses created from this form.

Resource type identifier. Always `forms`.

Form response resources for the current page.

Response submission time (ISO 8601 format)

Response data (JSON object). Keys are resolved to form field labels (dataLabel or label)

Relationships to the related form, post, and blog.

Relationship to the blog that owns the form response.

Relationship to the form that collected this response.

Relationship to the post where the form was embedded, when available.

Resource type identifier. Always `form_responses`.

JSON:API version metadata included in every JSON:API response.

Redirect URI that will be used for the callback

Per-post traffic metric rows for the requested date range.

Canonical URL (for duplicate content prevention)

"Post content HTML (generated with TipTap editor)

**Generation Method:**

- Inblog uses a TipTap-based WYSIWYG editor to generate HTML

- Real-time HTML conversion using editor.getHTML() method

- All content is managed in structured block units

**Basic HTML Tags:**

- Paragraph: `<p>`

- Headings: `<h2>`, `<h3>`, `<h4>` (h1, h5, h6 not supported)

- Lists: `<ul>`, `<ol>`, `<li>` (nesting supported)

- Text styles: `<strong>`, `<em>`, `<u>`, `<s>`, `<code>`

- Links: `<a>` (no rel attribute, nofollow removed)

- Quote: `<blockquote>`

- Horizontal rule: `<hr>`

- Line break: `<br>`

**Advanced Formatting:**

- Highlight: `<mark>` (multiple colors supported)
- Text color: `<span style="color: #hex;">` - Text alignment: `style="text-align: left|center|right;"`
- Code block: `<pre><code class="language-*">` (syntax highlighting supported)

**Tables:**

- `<table>`, `<thead>`, `<tbody>`, `<tr>`, `<th>`, `<td>`
- Resizable columns (colwidth attribute)
- Automatic horizontal scroll wrapping

**Custom Blocks (distinguished by data-type attribute):**

- Image: `<img data-type="imageBlock">` - Single image block
- Image grid: `<div data-type="imageGrid">` - Grid layout
- Image carousel: `<div data-type="imageCarousel">` - Slide format
- Callout: `<div data-type="callOut">` - Emphasis box
- Link button: `<div data-type="linkButton">` - CTA button
- Bookmark: `<div data-type="bookmark">` - URL preview

**Embed Support:**

- YouTube: `<div data-type="youtube" data-youtube-video-id="*">`
- Form services:
  - Google Forms: `<div data-type="googleForm">`
  - HubSpot: `<div data-type="hubspot">`
  - Tally: `<div data-type="tally">`
  - Typeform: `<div data-type="typeform">`
- HTML code block: `<section data-type="code-block"><div>...</div></section>` - Custom HTML insertion (iframes, etc). Must use `section` tag + `data-type="code-block"` + inner `<div>` wrapper to match the tiptap schema. `<div data-type="htmlCodeBlock">` will NOT work

**Security and Limitations:**

- `<script>` tags are automatically removed (XSS prevention)
- Images should use Inblog CDN (source.inblog.dev)
- External stylesheet links are restricted
- iframes are only allowed for permitted embed services

**Example:**

```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 button background color (hex color)
- 6-digit hex code (#RRGGBB)
- Default: blog theme color


CTA button background color type
- custom: use the custom color specified in cta_color
- preset: use blog preset color
- default: use blog theme color


URL to navigate to when CTA button is clicked

CTA button text color (hex color)
- 6-digit hex code (#RRGGBB)
- Default: #ffffff (white)


CTA button text color type
- custom: use the custom color specified in cta_text_color
- default: auto-calculated from button background contrast (#ffffff or #000000)
- Sending cta_text_color without setting this to 'custom' may result in the color being overridden by the editor


Post summary description (SEO meta description)

Form ID to attach to the post. Set to null to remove the form.

SEO meta description (displayed in search results)

SEO meta title (displayed in browser tab)

URL-friendly unique identifier. Only letters, numbers, and hyphens allowed

Post title (recommended under 60 characters for SEO)

Relationships from the post to tags and authors.

Resource type identifier
- Fixed value according to JSON:API standard
- Always "posts"


Related resources included alongside the post, such as tags or authors.

Traffic time-series rows for a single post.

Redirect rule resources for the current blog.

Redirect rule fields returned by the API.

Source path (redirect source)
- Must start with /
- Must be unique
- Wildcards not supported


Redirect type
- 307: Temporary Redirect
- 308: Permanent Redirect


Target path (redirect destination)
- Must start with /
- External URLs also allowed (http:// or https://)


Resource type identifier
- Fixed value according to JSON:API standard
- Always "redirects"


Related resource identifier, array of resource identifiers, or `null`.

Resource ID (required)
- String format
- Must be unique within its type

**Important:** The example value (123) is a sample. For actual use:
- Get Tag IDs: `GET /v1/tags`
- Get Author IDs: `GET /v1/authors`

Using non-existent IDs will result in a 400 error.


Resource type (required)
- posts, tags, authors etc.


OAuth authorization code returned by Google

Redirect URI used in the OAuth flow. Omit it to use the default dashboard callback.

Whether the token exchange and save operation succeeded

Whether Search Console remains connected after the operation

Whether the disconnect operation succeeded

Whether Search Console is currently connected

Connected Search Console property URL. Returns `null` when not connected.

Search Console performance rows for the requested date range.

Tag name (case-sensitive, must be unique)

URL-friendly unique identifier
- Only lowercase letters, numbers, and hyphens allowed
- Can be automatically generated from name


Resource type identifier
- Fixed value according to JSON:API standard
- Always "tags"


Traffic time-series rows for the requested date range.

Authoritative `publicUrl` of the uploaded asset

Accessible blog resources for the current user.

Blog attributes visible to the authenticated user.

Whether the current user is allowed to publish posts on this blog

Connected custom domain, if one is configured

Resource type identifier. Always `blogs`.

Use API key as Bearer token.

Format: `Authorization: Bearer YOUR_API_KEY`

API keys can be generated from the Inblog dashboard.


Use a signed user JWT as the Bearer token.

Format: `Authorization: Bearer USER_JWT`

This scheme is used for user-scoped endpoints such as `/user/blogs`.


Inblog Support

Manage blog content using the Inblog API.

## 🚀 Getting Started

### 1. Get API Key
Get your API key from the dashboard:
1. Login to [Inblog Dashboard](https://inblog.ai/dashboard)
2. Navigate to Settings → API Keys
3. Click "Create New API Key" button
4. Select required permission scopes
5. Store your API key securely

### 2. First Request
```bash
curl -X GET https://inblog.ai/api/v1/me \
  -H "Authorization: Bearer YOUR_API_KEY"
```

### 3. Use npm developer tools
If you prefer not to call the API manually, install the CLI:
```bash
npm install -g @inblog/cli
inblog auth login
```
For AI coding assistants, install AI Skills:
```bash
npx @inblog/ai-skills
```
The CLI manages posts, images, tags, authors, redirects, forms, analytics, and blog settings from your terminal. AI Skills install Inblog workflows for tools such as Codex, Claude Code, Cursor, GitHub Copilot, and Gemini.
Read the [Developer Tools guide](/docs/developer-tools/inblog-cli-and-ai-skills).

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

## 📋 Key Features

- **Post Management**: Create, update, delete, and publish posts
- **Tags and Authors**: Manage categories and author information
- **Blog Settings**: Modify basic settings
- **URL Redirects**: Configure 307 (temporary) and 308 (permanent) redirects
- **Forms & Responses**: View lead capture forms and submission data
- **JSON:API Standard**: Consistent response format

## 🔐 Authentication

All API requests require Bearer token authentication via Authorization header:

```
Authorization: Bearer YOUR_API_KEY
```
## 📚 Learn More

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

Proprietary

Inblog API

Retrieve all author profiles registered in the blog.

Remove the author's associations from posts in this blog. The author profile itself is not deleted.

Retrieve profile information for a specific author.

Update an author's profile information.

**Editable Fields:**
- author_name: Author display name
- avatar_url: Profile image URL

**Image Processing:**
Profile image URLs are uploaded to Inblog R2 storage by default.
To preserve original URLs, use the `preserve_external_images=true` query parameter.


Preserve external image URLs instead of uploading to R2 storage

preserve_external_images

Update an author's profile information using PUT.

**Editable Fields:**
- author_name: Author display name
- avatar_url: Profile image URL

**Image Processing:**
Profile image URLs are uploaded to Inblog R2 storage by default.
To preserve original URLs, use the `preserve_external_images=true` query parameter.


Get per-post performance metrics including visits, clicks, organic traffic, and conversion rate.

Start date (YYYY-MM-DD). Defaults to 28 days ago.

start_date

End date (YYYY-MM-DD). Defaults to today.

end_date

Set to "title" to include post titles in the response

Get traffic data over time for a specific post with daily or hourly granularity.

interval

Get traffic source analysis for a specific post showing referrer data.

Post traffic sources retrieved successfully

Get traffic source analysis showing referrer data sorted by visit count.

Get blog-wide traffic data with daily or hourly granularity. Includes visits, clicks, organic traffic, and page type breakdowns.

type

Retrieve the current banner and UI customization settings for your blog.

Update banner and UI customization settings. Only provided fields will be updated.

Retrieve the custom design code fields for your blog: banner and layout Handlebars templates, custom CSS, and header/footer HTML. Requires editor permission or higher on the blog.

Partially update design code fields. Only provided fields will be updated. Set a field to null to clear it. Requires editor permission or higher on the blog.

Validate a design code field without saving it. Handlebars template fields (custom_banner_code, custom_layout_code) are compiled against the registered helper set; syntax errors and unknown helpers are reported with line numbers. The CSS, header, and footer fields always pass. Validation is compile-level only — partials and helper calls without arguments can still fail at render time, so check the rendered blog page after saving. Requires editor permission or higher on the blog.

Validation completed. Check `data.valid` for the result.

Remove the custom domain from your blog. The blog will revert to the default subdomain.

Check the current custom domain configuration and DNS verification status.

Add a custom domain to your blog. Returns domain configuration including Vercel DNS settings required for verification.

Retrieve information about the blog connected to the current API key.

Update basic settings like blog name, description, logo, favicon, and featured image.

**Image Processing:**
Logo, favicon, and featured image URLs are uploaded to Inblog R2 storage by default.
To preserve original URLs, use the `preserve_external_images=true` query parameter.


Update basic settings like blog name, description, logo, favicon, and featured image using PUT.

**Image Processing:**
Logo, favicon, and featured image URLs are uploaded to Inblog R2 storage by default.
To preserve original URLs, use the `preserve_external_images=true` query parameter.


Exchange an OAuth authorization code for tokens to complete the Search Console connection.

Disconnect Google Search Console from your blog. Removes stored OAuth tokens.

Get keyword-level search performance data from Google Search Console. Returns clicks, impressions, CTR, and average position for each keyword.

Keyword performance data retrieved successfully

Get the Google OAuth URL for connecting Search Console. Use the optional redirect_uri parameter for CLI-based authentication flows.

redirect_uri

Get page-level search performance data from Google Search Console. Returns clicks, impressions, CTR, and average position for each page.

Page performance data retrieved successfully

Check whether Google Search Console is connected to your blog.

Retrieve a paginated list of form responses for the blog. You can filter by form ID, and each response includes relationship identifiers for the related form, post, and blog when available.

form_id

Retrieve detailed information for a specific form response by ID.

Retrieve a paginated list of forms for the blog. Each form includes its current response count.

Retrieve detailed information for a specific form by ID.

Retrieve information and permissions for the currently active API key.

View connected blog and list of granted permissions.


API key information retrieved successfully

Retrieve a list of published posts from the blog.
You can specify page number and size, and include tag or author information.

The post body (content_html) is not included in list responses. Request it explicitly with fields[posts] when you need it.


Create a new blog post.

**Required Fields:**
- title: Post title
- slug: URL slug (must be unique within the blog)

**Image Processing:**
External image URLs are uploaded to Inblog R2 storage by default.
To preserve original URLs, use the `preserve_external_images=true` query parameter.

**Limitations:**
- The id field is not allowed. Post ID is generated automatically by the server.
- To update an existing post, use PATCH /posts/{id}.

**Response Codes:**
- 201: Post created successfully
- 400: Bad request (e.g., id field included)
- 409: Slug already exists

External image URLs will be automatically saved to Inblog storage.


Permanently delete a post. This action cannot be undone.


Retrieve detailed information for a specific post by ID.

Update the content and settings of an existing post.

**Image Processing:**
External image URLs are uploaded to Inblog R2 storage by default.
To preserve original URLs, use the `preserve_external_images=true` query parameter.


Update a post using PUT. The current implementation treats PUT and PATCH identically.


Retrieve the list of authors associated with a post.

Replace all authors on a post with a new set of authors.
All existing authors are removed and only the newly specified authors remain.


Add one or more authors to a post.
Already connected authors are automatically skipped.


authorId

Publish a post immediately or schedule it for later.

**Supported Actions**:
- `publish` - Publish immediately
- `unpublish` - Unpublish
- `schedule` - Schedule publication (future time only)


Retrieve the list of tags associated with a post.

Replace all tags on a post with a new set of tags.
All existing tags are removed and only the newly specified tags remain.


Add one or more tags to a post.
Already connected tags are automatically skipped.


tagId

Retrieve all URL redirect rules configured for the blog.

Create a new redirect rule.
**Required Fields:** - from_path: Source path to redirect from - to_path: Target path to redirect to
**Response Codes:** - 201: Redirect created successfully - 409: from_path already exists


Permanently delete a redirect rule. ⚠️ This action cannot be undone!

Retrieve detailed information for a specific redirect rule.

Update a redirect rule using PUT. The current implementation treats PUT and PATCH identically.

Retrieve all tags registered in the blog.

Create a new tag.

**Required Fields:**
- name: Tag name
- slug: URL slug (must be unique within the blog)

**Response Codes:**
- 201: Tag created successfully
- 409: Slug already exists


Delete a tag. Existing post-tag relations are removed together with the tag.


Retrieve detailed information for a specific tag by ID.

Update a tag's name or other information.

Update a tag using PUT. The current implementation treats PUT and PATCH identically.


Upload an image file and receive a public URL.

**Request flow:**
- `fileKey` is required by the v1 contract, and its entire value is validated.
- A bare filename defaults to `post_image`; otherwise, the value must start with a supported image prefix. The prefix or default selects the asset bucket/type and required API scope.
- The validated requested object path and filename are not persisted as the stored key. To prevent key collisions and unauthorized overwrites, the server generates the final key as `<bucket>/api-<blogId>/<UUID>`.
- Treat the returned `publicUrl` as the authoritative URL for the uploaded asset.
- Send the raw file bytes as the request body.
- Allowed MIME types: `image/png`, `image/jpeg`, `image/gif`, `image/webp`, `image/x-icon`

**Limits:**
- Maximum file size: 10MB
- Upload rate limiting applies.


`fileKey` is required by the v1 contract, and its entire value is validated. A bare filename defaults to `post_image`; otherwise, use a supported image prefix. The prefix or default selects the asset type and required API scope. The validated requested path and filename are not persisted; the server generates `<bucket>/api-<blogId>/<UUID>`.

fileKey

Retrieve the list of blogs the currently authenticated user can access, including permission metadata.
