Gere documentação a partir de um script ou de um agente
Uma API REST, uma CLI e uma skill de agente para o Claude Code, o Cursor e outros agentes chamam as mesmas ações que a aplicação. Gere documentação a partir de um vídeo, edite um artigo e publique, no plano Solo / Small Team e acima.
Uma API de documentação, oito grupos de endpoints
Artigos, pastas, modelos, vídeos, geração, definições do projeto, publicação e exportação estão documentados numa única especificação OpenAPI, a mesma referência que um browser ou um gerador de código consegue ler. A tradução, o restauro de versões e a regeneração ficam dentro desses grupos.
Artigos, pastas e modelos
Gere, e depois consulte o trabalho
Definições do projeto e publicação
Receba uma chamada de retorno assinada em vez de consultar
Quatro âmbitos, aplicados por endpoint
Todos os pedidos v2 verificam os âmbitos da chave antes de correrem. O generate inicia um trabalho, o write cria, edita ou move conteúdo, o publish publica ou republica, e o read cobre tudo o resto. Uma chave age apenas no projeto para o qual foi emitida. Hoje todas as chaves levam os quatro âmbitos, porque a emissão de uma chave restrita ainda não está construída.
| Âmbito | O que permite | Por exemplo |
|---|---|---|
read | Ler artigos, pastas, modelos, vídeos, exportações e o estado de trabalhos | GET /articlesGET /generate/{jobId} |
write | Criar, mover, duplicar e restaurar conteúdo, e carregar vídeos | POST /articles/emptyPATCH /folders/{id}/move |
generate | Iniciar a geração, a regeneração e a tradução, e importar um vídeo a partir de um link | POST /generatePOST /videos/import |
publish | Publicar e republicar o projeto | POST /publishPOST /publish/republish |
Corra-o num terminal, ou entregue-o a um agente
A CLI envolve a mesma API, e a skill de agente envolve a CLI, por isso uma pessoa, um script e um agente como o Claude Code ou o Cursor chegam todos aos mesmos comandos. Acrescente --json para uma saída que um script consegue ler, e --wait para bloquear até um trabalho estar concluído.
$npm install -g @hintoai/cli
Instalar a CLI$hinto articles list
Listar todos os artigos do projeto$npx skills add hintoai/hinto-cli
Instalar a skill de agenteWebhooks: quatro eventos, um URL, os seus próprios cabeçalhos
Um projeto dispara um webhook ao publicar, republicar, anular a publicação e arquivar, levando quaisquer cabeçalhos que acrescente para autenticação. Cada chamada envia um nome de evento, o id do projeto e da publicação, uma marca temporal, e o nome e o slug do URL do projeto, um aviso de que algo aconteceu e de onde encontrá-lo, não o conteúdo em si.
project.publishQuando o projeto é publicado pela primeira vezproject.republishQuando o projeto é republicado com alteraçõesproject.unpublishQuando a publicação do projeto é anuladaproject.archiveQuando o projeto é arquivado
{
"event": "project.republish",
"projectId": "<project id>",
"publicationId": "<publication id>",
"timestamp": "2026-09-15T10:24:00.000Z",
"data": {
"projectName": "Acme Help Center",
"urlSlug": "acme"
}
}Enviada como POST com os seus cabeçalhos personalizados acrescentados. A Hinto tenta até 3 vezes, espera até 30 segundos por cada tentativa, e não repete uma resposta 4xx.Como funcionaLiga-se às ferramentas que 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 ao seu próprio endpoint e reaja a uma publicação, republicação, anulação de publicação ou arquivo no momento 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-o para o seu site
Um plugin do Framer importa artigos e pastas para o CMS do Framer, para um site construído e alojado no Framer.
O que as equipas automatizam
Artigos do centro de ajuda
Responda às perguntas que os clientes fazem sempre, em artigos que podem pesquisar.
SOPs e guias de processos
Transforme uma visita guiada gravada num SOP passo a passo, com capturas de ecrã nos passos que precisam de uma.
Contexto para as suas ferramentas de IA
Dê a um assistente os seus próprios processos escritos num único ficheiro de texto simples.
Outras funcionalidades
Perguntas sobre a API, a CLI e a skill de agente da Hinto
Não. Cada pedido leva um cabeçalho X-API-Key, de uma chave criada nas definições de um projeto.
Pronto para Criar uma Melhor
Base de Conhecimento, Mais Depressa?
Comece Grátis e Crie o Seu Primeiro Artigo em Minutos