POST /v1/convert
Cet endpoint convertit votre Markdown en un email HTML prêt à l’envoi.
Exigences d'Abonnement
- Conversion basique (Markdown vers HTML) : Disponible avec un abonnement actif
- Templates personnalisés (
template_id) : Disponible avec un abonnement actif - Orchestration IA (
ai_service) : Disponible avec un abonnement actif (BYOK requis)
Limites de Taux
Tous les utilisateurs avec un abonnement actif ont une limite de taux unifiée de 5 requêtes/seconde (~18 000 requêtes/heure).
Lorsque vous dépassez votre limite de taux, l'API retourne une réponse 429 Too Many Requests avec un en-tête Retry-After indiquant combien de secondes attendre avant de réessayer.
Tarification
- 1$/mois l'abonnement inclut 1 000 appels API
- Paiement à l'usage pour les appels supplémentaires au-delà du montant inclus
En-têtes
X-Typemail-Key: <VOTRE_API_KEY>
Content-Type: application/json
Corps de requête
| Nom | Type | Requis | Description |
|---|---|---|---|
markdown | string | oui | Contenu Markdown à convertir en HTML. Si ai_service est utilisé, le texte généré par l’IA remplace {ai_content} dans votre markdown. |
template_id | string | non | UUID du template (depuis votre Dashboard → Templates). Applique votre CSS personnalisé si fourni. |
ai_service | object | non | Paramètres d’orchestration IA. Requiert Pro/Business et une clé BYOK stockée pour le provider, sauf si vous passez api_key en ligne. |
Champs de ai_service :
| Champ | Type | Requis | Description |
|---|---|---|---|
provider | string | oui | L’un de : openai, anthropic, gemini. |
model | string | oui | Modèle du fournisseur (ex. gpt-4o, claude-3-sonnet, gemini-1.5-pro). |
prompt | string | oui | Prompt utilisateur pour générer du contenu. |
api_key | string | non | Clé API du fournisseur en ligne. Si omise, le serveur utilise votre BYOK stockée pour ce provider. |
max_tokens | number | non | Limite de tokens (selon provider). |
temperature | number | non | Température d’échantillonnage. |
system | string | non | Prompt système optionnel (si supporté). |
Exemple (cURL)
curl -X POST https://<VOTRE-URL-PROJET>/functions/v1/convert \
-H "X-Typemail-Key: $TYPEMAIL_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"markdown": "# Bonjour !\nCeci est **Typemail**.\n\nGénéré : {ai_content}",
"template_id": "<VOTRE_TEMPLATE_UUID>",
"ai_service": {
"provider": "openai",
"model": "gpt-4o",
"prompt": "Rédige une brève salutation pour notre newsletter",
"max_tokens": 200,
"temperature": 0.7
}
}'