Integrar

Gere documentação a partir de um script ou um agente

Uma API REST, uma CLI e uma skill de agente para Claude Code, Cursor e outros agentes chamam as mesmas ações do app. Gere documentação a partir de um vídeo, edite um artigo e publique, no plano Solo / Small Team e acima.

Uma chamada de fora do app
POST/api/external/v2/generate
202Aceito, trabalho na fila

Uma API de documentação, oito grupos de endpoints

Artigos, pastas, modelos, vídeos, geração, configurações do projeto, publicação e exportação estão documentados em uma única especificação OpenAPI, a mesma referência que um navegador ou um gerador de código consegue ler. Tradução, restauração de versão e regeneração ficam dentro desses grupos.

Artigos, pastas e modelos

Crie, atualize, mova e exclua artigos e pastas, e leia modelos, com um cabeçalho X-API-Key autenticando cada requisição.
Como isso funciona
PUT/api/external/v2/articles/{id}X-API-Key: <your key>{ "title": "Reset your password" }

Gere e depois acompanhe o trabalho

Aponte o endpoint de geração para um vídeo e ele coloca um trabalho na fila. Consulte o trabalho pelo id para ver o status, o mesmo padrão assíncrono que o próprio app usa para uma execução longa.
Como isso funciona
POST/api/external/v2/generate{ "videoId": "<video id>" }202 { "jobId": "<job id>", "type": "generate_article" }GET/api/external/v2/generate/{jobId}200 { "status": "completed" }

Configurações do projeto e publicação

Leia e atualize as configurações do projeto, e publique, republique ou despublique, pelo mesmo pipeline de publicação que a tela de configurações do app usa.
Como isso funciona
POST/api/external/v2/publishPOST/api/external/v2/publish/republishDELETE/api/external/v2/publish

Receba um callback assinado em vez de consultar

Adicione um callbackUrl a uma chamada de geração, regeneração, tradução ou publicação, e a Hinto envia um POST para ele quando o trabalho termina ou falha. Adicione um callbackSecret e cada chamada leva um cabeçalho X-Hinto-Signature, um HMAC-SHA256 do corpo, para você conferir que veio da Hinto. Uma entrega que falha é tentada até 5 vezes.
Como isso funciona
POST/api/external/v2/generate{ "videoId": "<video id>", "callbackUrl": "<your url>" }POST<your url>X-Hinto-Signature: <hmac>{ "event": "generation.completed", "jobId": "<job id>" }

Quatro escopos, aplicados por endpoint

Cada requisição v2 confere os escopos da chave antes de rodar. Generate inicia um trabalho, write cria, edita ou move conteúdo, publish publica ou republica, e read cobre todo o resto. Uma chave age somente no projeto para o qual foi emitida. Hoje toda chave leva os quatro escopos, já que emitir uma chave restrita ainda não está pronto.

EscopoO que permitePor exemplo
readLer artigos, pastas, modelos, vídeos, exportações e status de trabalhosGET /articlesGET /generate/{jobId}
writeCriar, mover, duplicar e restaurar conteúdo, e enviar vídeosPOST /articles/emptyPATCH /folders/{id}/move
generateIniciar geração, regeneração e tradução, e importar um vídeo por linkPOST /generatePOST /videos/import
publishPublicar e republicar o projetoPOST /publishPOST /publish/republish

Rode pelo terminal, ou entregue a um agente

A CLI envolve a mesma API, e a skill de agente envolve a CLI, então uma pessoa, um script e um agente como o Claude Code ou o Cursor chegam aos mesmos comandos. Adicione --json para uma saída que um script consegue ler, e --wait para esperar até o trabalho terminar.

$npm install -g @hintoai/cli

Instale a CLI

$hinto articles list

Liste todos os artigos do projeto

$npx skills add hintoai/hinto-cli

Instale a skill de agente

Webhooks: quatro eventos, uma URL, os seus cabeçalhos

Um projeto dispara um webhook na publicação, republicação, despublicação e arquivamento, levando qualquer cabeçalho que você adicionar para autenticação. Cada chamada envia o nome do evento, o id do projeto e da publicação, uma marcação de tempo, e o nome e o slug de URL do projeto, um aviso de que algo aconteceu e onde encontrar, não o conteúdo em si.

  • project.publishQuando o projeto é publicado pela primeira vez
  • project.republishQuando o projeto é republicado com mudanças
  • project.unpublishQuando o projeto é despublicado
  • project.archiveQuando o projeto é arquivado
POSThttps://api.example.com/webhooksContent-Type: application/json
{
  "event": "project.republish",
  "projectId": "<project id>",
  "publicationId": "<publication id>",
  "timestamp": "2026-09-15T10:24:00.000Z",
  "data": {
    "projectName": "Acme Help Center",
    "urlSlug": "acme"
  }
}
Enviado como POST com os seus cabeçalhos personalizados. A Hinto tenta até 3 vezes, espera até 30 segundos por tentativa, e não repete uma resposta 4xx.Como isso funciona

Conecta às ferramentas que você já usa

Um webhook, uma caixa de entrada de suporte e um construtor de sites podem todos ler do mesmo projeto.

Um webhook para os seus próprios sistemas

Aponte um webhook para o seu próprio endpoint e reaja a uma publicação, republicação, despublicação ou arquivamento na hora em que acontece.

O Fin do Intercom responde a partir dele

Sincronize o conteúdo de um projeto com o Intercom para que o Fin, o agente de suporte do Intercom, responda a partir do que a Hinto gerou.

O Framer importa para o seu site

Um plugin do Framer importa artigos e pastas para o CMS do Framer, para um site construído e hospedado no Framer.

Perguntas sobre a API, a CLI e a skill de agente da Hinto

Não. Cada requisição leva um cabeçalho X-API-Key, de uma chave criada nas configurações de um projeto.

Pronto para Criar uma
Base de Conhecimento Melhor, Mais Rápido?

Comece Grátis e Crie Seu Primeiro Artigo em Minutos