Pular para o conteúdo principal

​
Endpoint

POST https://api.bunny.build/api/v1/markdown-to-html

​
Autenticação

HeaderObrigatórioValor
X-API-KeySimSua chave de API (bun_...)
Content-TypeSimapplication/json

​
Visão geral

Converta código-fonte Markdown em HTML sanitizado pronto para renderização em navegadores ou clientes de e-mail. Suporta GitHub Flavored Markdown (GFM), tabelas, listas de tarefas, blocos de código delimitados com destaque de sintaxe e tachado. A saída é sanitizada para prevenir XSS.

​
Casos de uso

  • Renderizar conteúdo Markdown gerado por usuários com segurança em aplicações web
  • Converter arquivos README ou de documentação para HTML
  • Processar rascunhos de posts de blog escritos em Markdown
  • Gerar e-mails HTML a partir de templates em Markdown

​
Detalhes

A análise segue a especificação CommonMark com extensões GFM. O HTML presente na entrada é sanitizado. Blocos de código são envoltos em tags <pre><code> com uma classe de linguagem para destaque baseado em CSS.

​
Corpo da requisição

CampoTipoObrigatórioDescrição
markdownstringSimTexto Markdown a converter

​
Exemplo

{
  "markdown": "# Hello\n\nThis is **bold** and _italic_ text.\n\n```js\nconsole.log('hi');\n```"
}

​
Resposta

​
200 OK

CampoTipoDescrição
htmlstringHTML renderizado e sanitizado
Exemplo 
{
  "html": "<h1>Hello</h1>\n<p>This is <strong>bold</strong> and <em>italic</em> text.</p>\n<pre><code class=\"language-js\">console.log('hi');\n</code></pre>"
}

​
401 Unauthorized

{
  "detail": "Missing API key. Include X-API-Key header."
}

​
402 Payment Required

{
  "detail": "Monthly quota exceeded. Upgrade your plan."
}

​
422 Unprocessable Entity

{
  "detail": "Missing required field: markdown"
}

​
429 Too Many Requests

{
  "detail": "Rate limit exceeded. Try again in 60 seconds."
}

​
Exemplo cURL

curl -X POST https://api.bunny.build/api/v1/markdown-to-html \
  -H "X-API-Key: bun_sua_chave_api" \
  -H "Content-Type: application/json" \
  -d '{"markdown": "# Hello\n\nThis is **bold** text."}'