Campos do post a retornar, separados por vírgula. Nomes desconhecidos são ignorados. Inclua content_html para solicitar o corpo, omitido por padrão.

fields[posts]

Retorna apenas posts do autor especificado.

filter[author_id]

filter[content_type]

Retorna apenas posts publicados nesta data ou depois dela. (formato ISO 8601)

filter[published_at_gte]

Retorna apenas posts publicados nesta data ou antes dela. (formato ISO 8601)

filter[published_at_lte]

filter[published]

Filtre por slug. Retorna apenas posts com correspondência exata.

filter[slug]

Retorna apenas posts com a tag especificada.

filter[tag_id]

Especifique os recursos relacionados a incluir, separados por vírgulas

Valores disponíveis para Posts:
- `tags` - Tags do post
- `authors` - Autores do post


include

Itens por página O formato JSON:API `page[size]` também é aceito.

limit

order

Número da página (começando em 1) O formato JSON:API `page[number]` também é aceito.

page

sort

Atributos da API key e scopes concedidos.

Lista de permissões concedidas à API key

Identificador de tipo de recurso. Sempre `api_keys`.

Nome de exibição do autor
- Nome exibido no blog
- Pode usar apelido ou pseudônimo


URL da imagem de perfil
- Recomenda-se fazer upload para o armazenamento da Inblog
- Proporção: 1:1 (quadrada)
- Tamanho recomendado: 400x400px


Identificador do tipo de recurso
- Valor fixo conforme o padrão JSON:API
- Sempre "authors"


Código de idioma do blog (ISO 639-1)
- Padrão: ko (coreano)
- Usado no atributo lang do HTML


Status de verificação do domínio personalizado

URL do favicon
- Tamanho: 32x32px ou 64x64px
- Formato ICO ou PNG


ID de medição do Google Analytics 4 conectado ao blog

Se o Google Search Console está conectado no momento

URL da imagem do logo
- Tamanho recomendado: 200x50px (paisagem)
- Recomenda-se PNG com fundo transparente


URL do logo (descontinuado, use logo em vez disso)

URL da imagem destacada Open Graph
- Imagem exibida ao compartilhar em redes sociais
- Tamanho recomendado: 1200x630px


Plano de assinatura (somente leitura)
- free: plano gratuito
- team: plano Team
- enterprise: plano Enterprise


URL da propriedade do Google Search Console vinculada a este blog

Diferença de horário em relação ao UTC (em horas)
- Coreia: 9 (UTC+9)
- Japão: 9 (UTC+9)
- Leste dos EUA: -5 (UTC-5)


Horário da última atualização do blog (ISO 8601)

Identificador do tipo de recurso
- Valor fixo conforme o padrão JSON:API
- Sempre "blogs"


Payload do recurso de blog a ser atualizado.

Texto exibido no item de navegação do cabeçalho

URL de destino aberta quando o item de navegação é clicado

Cor de fundo do banner em formato hexadecimal

Texto de apoio exibido abaixo do título do banner

Cor do título do banner em formato hexadecimal

Texto do rodapé exibido na parte inferior do blog

Itens de navegação do cabeçalho exibidos no topo do blog

Payload no estilo JSON:API para atualizar as configurações de UI personalizada.

Informe qualquer subconjunto de campos para atualizar. Apenas os campos incluídos serão modificados.

Payload no estilo JSON:API para adicionar um domínio personalizado.

Domínio personalizado a ser conectado. Forneça apenas o hostname, sem protocolo.

Domínio personalizado que foi salvo no blog

Resposta bruta da criação de domínio da Vercel. O conjunto exato de campos varia conforme o estado atual do domínio na Vercel.

Estado de verificação inicial salvo para o domínio

Se o domínio personalizado foi removido com sucesso

Se um domínio personalizado está configurado atualmente para o blog

Domínio personalizado configurado atualmente

Resposta bruta de status de project-domain da Vercel

Resposta bruta da tentativa de verificação da Vercel, retornada quando o domínio ainda não foi verificado

Estado de verificação armazenado no registro do blog

Recursos de formulário para a página atual.

Campos do formulário retornados pela API.

Horário de criação do formulário (formato ISO 8601)

Configurações de notificação por e-mail

Configurações da mensagem de agradecimento

Relacionamentos do formulário com suas respostas enviadas.

Relacionamento com as respostas do formulário criadas a partir deste formulário.

Identificador de tipo de recurso. Sempre `forms`.

Recursos de resposta de formulário para a página atual.

Campos da resposta enviada do formulário.

Horário de envio da resposta (formato ISO 8601)

Dados da resposta (objeto JSON). As chaves são resolvidas para os rótulos dos campos do formulário (dataLabel ou label)

Relacionamentos com o formulário, o post e o blog relacionados.

Relacionamento com o blog que é dono da resposta do formulário.

Relacionamento com o formulário que coletou esta resposta.

Relacionamento com o post onde o formulário foi incorporado, quando disponível.

Identificador de tipo de recurso. Sempre `form_responses`.

Metadados da versão JSON:API incluídos em toda resposta JSON:API.

Redirect URI que será usada para o callback

Título do post (incluído quando include=title)

Linhas de métricas de tráfego por post para o intervalo de datas solicitado.

Campos principais do post retornados pela API.

URL canônica (para prevenção de conteúdo duplicado)

"HTML do conteúdo do post (gerado com o editor TipTap)

**Método de geração:**

- O Inblog usa um editor WYSIWYG baseado em TipTap para gerar HTML

- Conversão de HTML em tempo real usando o método editor.getHTML()

- Todo o conteúdo é gerenciado em unidades de bloco estruturadas

**Tags HTML básicas:**

- Parágrafo: `<p>`

- Títulos: `<h2>`, `<h3>`, `<h4>` (h1, h5, h6 não suportados)

- Listas: `<ul>`, `<ol>`, `<li>` (aninhamento suportado)

- Estilos de texto: `<strong>`, `<em>`, `<u>`, `<s>`, `<code>`

- Links: `<a>` (sem atributo rel, nofollow removido)

- Citação: `<blockquote>`

- Linha horizontal: `<hr>`

- Quebra de linha: `<br>`

**Formatação avançada:**

- Destaque: `<mark>` (múltiplas cores suportadas)
- Cor do texto: `<span style="color: #hex;">` - Alinhamento do texto: `style="text-align: left|center|right;"`
- Bloco de código: `<pre><code class="language-*">` (realce de sintaxe suportado)

**Tabelas:**

- `<table>`, `<thead>`, `<tbody>`, `<tr>`, `<th>`, `<td>`
- Colunas redimensionáveis (atributo colwidth)
- Quebra automática com rolagem horizontal

**Blocos personalizados (distinguidos pelo atributo data-type):**

- Imagem: `<img data-type="imageBlock">` - Bloco de imagem única
- Grade de imagens: `<div data-type="imageGrid">` - Layout em grade
- Carrossel de imagens: `<div data-type="imageCarousel">` - Formato de slides
- Callout: `<div data-type="callOut">` - Caixa de destaque
- Botão de link: `<div data-type="linkButton">` - Botão CTA
- Bookmark: `<div data-type="bookmark">` - Pré-visualização de URL

**Suporte a embeds:**

- YouTube: `<div data-type="youtube" data-youtube-video-id="*">`
- Serviços de formulário:
  - Google Forms: `<div data-type="googleForm">`
  - HubSpot: `<div data-type="hubspot">`
  - Tally: `<div data-type="tally">`
  - Typeform: `<div data-type="typeform">`
- Bloco de código HTML: `<section data-type="code-block"><div>...</div></section>` - Inserção de HTML personalizado (iframes, etc). Você deve usar a tag `section` + `data-type="code-block"` + wrapper interno `<div>` para corresponder ao schema do tiptap. `<div data-type="htmlCodeBlock">` NÃO funcionará

**Segurança e limitações:**

- Tags `<script>` são removidas automaticamente (prevenção de XSS)
- As imagens devem usar o CDN do Inblog (source.inblog.dev)
- Links de folhas de estilo externas são restritos
- iframes só são permitidos para serviços de embed autorizados

**Exemplo:**

```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"


Cor de fundo do botão CTA (cor hex)
- Código hex de 6 dígitos (#RRGGBB)
- Padrão: cor do tema do blog


Tipo de cor de fundo do botão CTA
- custom: usa a cor personalizada especificada em cta_color
- preset: usa a cor predefinida do blog
- default: usa a cor do tema do blog


URL para a qual navegar quando o botão CTA é clicado

Cor do texto do botão CTA (cor hex)
- Código hex de 6 dígitos (#RRGGBB)
- Padrão: #ffffff (branco)


Tipo de cor do texto do botão CTA
- custom: usa a cor personalizada especificada em cta_text_color
- default: calculada automaticamente a partir do contraste com o fundo do botão (#ffffff ou #000000)
- Enviar cta_text_color sem definir isto como 'custom' pode resultar na cor sendo sobrescrita pelo editor


Descrição resumida do post (meta description de SEO)

ID do formulário a anexar ao post. Defina como null para remover o formulário.

Meta description de SEO (exibida nos resultados de busca)

Meta title de SEO (exibido na aba do navegador)

Horário de publicação do post (formato ISO 8601)

Identificador único compatível com URL. Apenas letras, números e hifens são permitidos

Título do post (recomendado abaixo de 60 caracteres para SEO)

Relacionamentos do post com tags e autores.

Identificador de tipo de recurso
- Valor fixo conforme o padrão JSON:API
- Sempre "posts"


Recursos relacionados incluídos junto com o post, como tags ou autores.

Linhas de série temporal de tráfego para um único post.

Payload do recurso de redirect a ser criado.

Recursos de regra de redirect para o blog atual.

Campos da regra de redirect retornados pela API.

Caminho de origem (origem do redirect)
- Deve começar com /
- Deve ser único
- Wildcards não são suportados


Tipo de redirect
- 307: Temporary Redirect
- 308: Permanent Redirect


Caminho de destino (destino do redirect)
- Deve começar com /
- URLs externas também são permitidas (http:// ou https://)


Identificador do tipo de recurso
- Valor fixo de acordo com o padrão JSON:API
- Sempre "redirects"


Payload do recurso de redirect a atualizar.

Linhas de referenciadores classificadas por número de visitas.

Identificador de recurso relacionado, array de identificadores de recurso ou `null`.

ID do recurso (obrigatório)
- Formato de string
- Deve ser único dentro do seu tipo

**Importante:** O valor de exemplo (123) é apenas uma amostra. Para uso real:
- Obtenha os IDs de Tag: `GET /v1/tags`
- Obtenha os IDs de Author: `GET /v1/authors`

Usar IDs inexistentes resultará em um erro 400.


Tipo de recurso (obrigatório)
- posts, tags, authors etc.


Código de autorização OAuth retornado pelo Google

Redirect URI usada no fluxo OAuth. Omita-a para usar o callback padrão do dashboard.

Se o Search Console está conectado agora

Se a operação de troca e salvamento do token foi bem-sucedida

Se o Search Console permanece conectado após a operação

Se a operação de desconexão foi bem-sucedida

Se o Search Console está conectado no momento

URL da propriedade do Search Console conectada. Retorna `null` quando não conectado.

Linhas de desempenho do Search Console para o intervalo de datas solicitado.

Nome da tag (sensível a maiúsculas e minúsculas, deve ser único)

Identificador único amigável para URL
- Apenas letras minúsculas, números e hifens são permitidos
- Pode ser gerado automaticamente a partir do nome


Identificador de tipo de recurso
- Valor fixo conforme o padrão JSON:API
- Sempre "tags"


Linhas de série temporal de tráfego para o intervalo de datas solicitado.

Recursos de blog acessíveis para o usuário atual.

Atributos do blog visíveis para o usuário autenticado.

Indica se o usuário atual tem permissão para publicar posts neste blog

Domínio personalizado conectado, se houver um configurado

ID numérico do blog serializado como string

Identificador de tipo de recurso. Sempre `blogs`.

Use a API key como token Bearer.

Formato: `Authorization: Bearer YOUR_API_KEY`

As API keys podem ser geradas no painel da Inblog.


Use um JWT de usuário assinado como o token Bearer.

Formato: `Authorization: Bearer USER_JWT`

Esse esquema é usado em endpoints com escopo de usuário, como `/user/blogs`.


Inblog Support

Gerencie o conteúdo do blog usando a Inblog API.

## 🚀 Primeiros passos

### 1. Obtenha a API key
Obtenha sua API key no dashboard:
1. Faça login no [Inblog Dashboard](https://inblog.ai/dashboard)
2. Navegue até Settings → API Keys
3. Clique no botão "Create New API Key"
4. Selecione os escopos de permissão necessários
5. Armazene sua API key com segurança

### 2. Primeira requisição
```bash
curl -X GET https://api.inblog.ai/api/v1/me \
  -H "Authorization: Bearer YOUR_API_KEY"
```

### 3. Use as ferramentas de desenvolvedor do npm
Se preferir não chamar a API manualmente, instale a CLI:
```bash
npm install -g @inblog/cli
inblog auth login
```
Para assistentes de programação com IA, instale as AI Skills:
```bash
npx @inblog/ai-skills
```
A CLI gerencia posts, imagens, tags, autores, redirects, formulários, analytics e configurações do blog a partir do seu terminal. As AI Skills instalam os fluxos de trabalho da Inblog para ferramentas como Codex, Claude Code, Cursor, GitHub Copilot e Gemini.
Leia o [guia de Ferramentas de Desenvolvedor](/docs/developer-tools/inblog-cli-and-ai-skills).

### 4. Content-Type
- **Requisição**: `Content-Type: application/json` ou `application/vnd.api+json`
- **Resposta**: `Content-Type: application/vnd.api+json`

## 📋 Principais recursos

- **Gerenciamento de posts**: Crie, atualize, exclua e publique posts
- **Tags e autores**: Gerencie categorias e informações de autores
- **Configurações do blog**: Modifique configurações básicas
- **Redirects de URL**: Configure redirects 307 (temporário) e 308 (permanente)
- **Formulários e respostas**: Visualize formulários de captura de leads e dados de envio
- **Padrão JSON:API**: Formato de resposta consistente

## 🔐 Autenticação

Todas as requisições à API exigem autenticação por Bearer token através do cabeçalho Authorization:

```
Authorization: Bearer YOUR_API_KEY
```
## 📚 Saiba mais

- [Especificação JSON:API](https://jsonapi.org/)

Proprietary

Inblog API

Recupera todos os perfis de autores registrados no blog.

Remove as associações do autor com os posts deste blog. O perfil do autor em si não é excluído.

Recupera as informações de perfil de um autor específico.

Atualiza as informações de perfil de um autor.

**Campos Editáveis:**
- author_name: Nome de exibição do autor
- avatar_url: URL da imagem de perfil

**Processamento de Imagem:**
Por padrão, as URLs de imagem de perfil são enviadas para o armazenamento Inblog R2.
Para preservar as URLs originais, use o parâmetro de query `preserve_external_images=true`.


Preserva as URLs de imagem externas em vez de enviá-las para o armazenamento R2

preserve_external_images

Atualiza as informações de perfil de um autor usando PUT.

**Campos Editáveis:**
- author_name: Nome de exibição do autor
- avatar_url: URL da imagem de perfil

**Processamento de Imagem:**
Por padrão, as URLs de imagem de perfil são enviadas para o armazenamento Inblog R2.
Para preservar as URLs originais, use o parâmetro de query `preserve_external_images=true`.


Obtenha métricas de desempenho por post, incluindo visitas, cliques, tráfego orgânico e taxa de conversão.

Data de início (YYYY-MM-DD). O padrão é 28 dias atrás.

start_date

Data de término (YYYY-MM-DD). O padrão é hoje.

end_date

Defina como "title" para incluir os títulos dos posts na resposta

Métricas dos posts recuperadas com sucesso

Obtenha os dados de tráfego ao longo do tempo de um post específico com granularidade diária ou por hora.

Intervalo de tempo para a agregação dos dados

interval

Dados de tráfego do post recuperados com sucesso

Obtenha a análise das fontes de tráfego de um post específico mostrando os dados de referrer.

Fontes de tráfego do post recuperadas com sucesso

Obtenha a análise das fontes de tráfego mostrando os dados de referrer ordenados por número de visitas.

Fontes de tráfego recuperadas com sucesso

Obtém dados de tráfego de todo o blog com granularidade diária ou horária. Inclui visitas, clicks, tráfego orgânico e detalhamentos por tipo de página.

Data de início (YYYY-MM-DD). Padrão: 28 dias atrás.

Data de término (YYYY-MM-DD). Padrão: hoje.

Intervalo de tempo para agregação de dados

type

Recupera as configurações atuais de banner e personalização de UI do seu blog.

Configurações de UI recuperadas com sucesso

Atualiza as configurações de personalização de banner e UI. Apenas os campos fornecidos serão atualizados.

Configurações de UI atualizadas com sucesso

Remove o domínio personalizado do seu blog. O blog reverterá para o subdomínio padrão.

Domínio personalizado removido com sucesso

Verifica a configuração atual do domínio personalizado e o status de verificação de DNS.

Status do domínio recuperado com sucesso

Adiciona um domínio personalizado ao seu blog. Retorna a configuração do domínio, incluindo as configurações de DNS da Vercel necessárias para a verificação.

Domínio personalizado adicionado com sucesso

Recupera informações sobre o blog conectado à API key atual.

Atualiza configurações básicas como nome do blog, descrição, logo, favicon e imagem em destaque.

**Processamento de Imagem:**
Por padrão, as URLs de logo, favicon e imagem em destaque são enviadas para o armazenamento Inblog R2.
Para preservar as URLs originais, use o parâmetro de query `preserve_external_images=true`.


Atualiza configurações básicas como nome do blog, descrição, logo, favicon e imagem em destaque usando PUT.

**Processamento de Imagem:**
Por padrão, as URLs de logo, favicon e imagem em destaque são enviadas para o armazenamento Inblog R2.
Para preservar as URLs originais, use o parâmetro de query `preserve_external_images=true`.


Atualizar as Configurações do Meu Blog (PUT)

Troca um código de autorização OAuth por tokens para concluir a conexão com o Search Console.

Desconecta o Google Search Console do seu blog. Remove os tokens OAuth armazenados.

Obtém dados de desempenho de busca em nível de palavra-chave do Google Search Console. Retorna clicks, impressions, CTR e average position para cada palavra-chave.

Dados de desempenho de palavras-chave obtidos com sucesso

Obtém a URL OAuth do Google para conectar o Search Console. Use o parâmetro opcional redirect_uri para fluxos de autenticação baseados em CLI.

URI de redirecionamento personalizada para callback de CLI

redirect_uri

Obtém dados de desempenho de busca em nível de página do Google Search Console. Retorna clicks, impressions, CTR e average position para cada página.

Dados de desempenho de páginas obtidos com sucesso

Verifica se o Google Search Console está conectado ao seu blog.

Recupera uma lista paginada de respostas de formulário do blog. Você pode filtrar por ID do formulário, e cada resposta inclui identificadores de relacionamento para o formulário, post e blog relacionados, quando disponíveis.

form_id

Respostas de formulário recuperadas com sucesso

Recupera informações detalhadas de uma resposta de formulário específica por ID.

Resposta de formulário recuperada com sucesso

Recupera uma lista paginada de formulários do blog. Cada formulário inclui sua contagem atual de respostas.

Recupera informações detalhadas de um formulário específico por ID.

Recupere as informações e permissões da API key ativa no momento.

Visualize o blog conectado e a lista de permissões concedidas.


Informações da API key recuperadas com sucesso

Recupere uma lista dos posts publicados do blog.
Você pode especificar o número e o tamanho da página, e incluir informações de tag ou autor.
O corpo do post (content_html) não é incluído nas respostas de listagem. Solicite-o explicitamente com fields[posts] quando necessário.


Crie um novo post de blog.

**Campos obrigatórios:**
- title: Título do post
- slug: Slug da URL (deve ser único dentro do blog)

**Processamento de imagens:**
Por padrão, as URLs de imagens externas são enviadas para o armazenamento Inblog R2.
Para preservar as URLs originais, use o parâmetro de query `preserve_external_images=true`.

**Limitações:**
- O campo id não é permitido. O Post ID é gerado automaticamente pelo servidor.
- Para atualizar um post existente, use PATCH /posts/{id}.

**Códigos de resposta:**
- 201: Post criado com sucesso
- 400: Requisição inválida (por exemplo, campo id incluído)
- 409: Slug já existe

As URLs de imagens externas serão salvas automaticamente no armazenamento Inblog.
