Saltar al contenido principal

POST /v1/convert

Este endpoint convierte tu Markdown en un correo HTML listo para enviar.

Requisitos de Suscripción
  • Conversión básica (Markdown a HTML): Disponible con suscripción activa
  • Plantillas personalizadas (template_id): Disponible con suscripción activa
  • Orquestación IA (ai_service): Disponible con suscripción activa (BYOK requerido)

Límites de Tasa

Todos los usuarios con una suscripción activa tienen un límite de tasa unificado de 5 solicitudes/segundo (~18.000 solicitudes/hora).

Cuando excedes tu límite de tasa, la API devuelve una respuesta 429 Too Many Requests con un encabezado Retry-After que indica cuántos segundos esperar antes de reintentar.

Precios

  • $1/mes la suscripción incluye 1.000 llamadas API
  • Pago por uso para llamadas adicionales más allá de la cantidad incluida

Encabezados

X-Typemail-Key: <TU_API_KEY>
Content-Type: application/json

Cuerpo de la solicitud

NombreTipoRequeridoDescripción
markdownstringContenido Markdown a convertir en HTML. Si se usa ai_service, el texto generado por IA reemplaza {ai_content} en tu markdown.
template_idstringnoUUID de la plantilla (desde tu Dashboard → Plantillas). Aplica tu CSS personalizado si se proporciona.
ai_serviceobjectnoParámetros de orquestación de IA. Requiere Pro/Business y una clave BYOK almacenada para el provider, a menos que pases api_key en línea.

Campos de ai_service:

CampoTipoRequeridoDescripción
providerstringUno de: openai, anthropic, gemini.
modelstringModelo del proveedor (p. ej. gpt-4o, claude-3-sonnet, gemini-1.5-pro).
promptstringPrompt del usuario para generar contenido.
api_keystringnoClave del proveedor en línea. Si se omite, el servidor usará tu BYOK almacenada para ese proveedor.
max_tokensnumbernoMáximo de tokens (según el proveedor).
temperaturenumbernoTemperatura de muestreo.
systemstringnoPrompt del sistema opcional (si está soportado).

Ejemplo (cURL)

curl -X POST https://<TU-URL-PROYECTO>/functions/v1/convert \
-H "X-Typemail-Key: $TYPEMAIL_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"markdown": "# Hola, mundo!\nEsto es **Typemail**.\n\nGenerado: {ai_content}",
"template_id": "<TU_TEMPLATE_UUID>",
"ai_service": {
"provider": "openai",
"model": "gpt-4o",
"prompt": "Escribe un breve saludo para nuestro boletín",
"max_tokens": 200,
"temperature": 0.7
}
}'