POST /v1/convert
Dieser Endpunkt wandelt Ihr Markdown in eine versandfertige HTML-E-Mail um.
Abonnement-Anforderungen
- Grundlegende Konvertierung (Markdown zu HTML): Verfügbar mit aktivem Abonnement
- Benutzerdefinierte Vorlagen (
template_id): Verfügbar mit aktivem Abonnement - KI-Orchestrierung (
ai_service): Verfügbar mit aktivem Abonnement (BYOK erforderlich)
Ratenbegrenzungen
Alle Benutzer mit einem aktiven Abonnement haben eine einheitliche Ratenbegrenzung von 5 Anfragen/Sekunde (~18.000 Anfragen/Stunde).
Wenn Sie Ihre Ratenbegrenzung überschreiten, gibt die API eine 429 Too Many Requests-Antwort mit einem Retry-After-Header zurück, der angibt, wie viele Sekunden Sie warten müssen, bevor Sie es erneut versuchen.
Preise
- $1/Monat Abonnement beinhaltet 1.000 API-Aufrufe
- Nutzungsbasierte Abrechnung für zusätzliche Aufrufe über den enthaltenen Betrag hinaus
Header
X-Typemail-Key: <IHR_API_KEY>
Content-Type: application/json
Anfragetext
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
markdown | string | ja | Markdown-Inhalt, der in HTML umgewandelt wird. Wenn ai_service verwendet wird, ersetzt der von der KI generierte Text {ai_content} in Ihrem Markdown. |
template_id | string | nein | UUID der Vorlage (aus Ihrem Dashboard → Vorlagen). Wendet bei Angabe Ihr benutzerdefiniertes CSS an. |
ai_service | object | nein | Parameter für die KI-Orchestrierung. Erfordert Pro/Business und einen gespeicherten BYOK-Schlüssel für den provider, es sei denn, Sie übergeben api_key inline. |
Felder von ai_service:
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
provider | string | ja | Eines von: openai, anthropic, gemini. |
model | string | ja | Modellname des Anbieters (z. B. gpt-4o, claude-3-sonnet, gemini-1.5-pro). |
prompt | string | ja | Benutzer-Prompt zur Inhaltserzeugung. |
api_key | string | nein | Inline-API-Schlüssel des Anbieters. Wenn weggelassen, verwendet der Server Ihren gespeicherten BYOK-Schlüssel für den jeweiligen Anbieter. |
max_tokens | number | nein | Maximale Tokenzahl (anbieterabhängig). |
temperature | number | nein | Abtasttemperatur. |
system | string | nein | Optionaler System-Prompt (falls unterstützt). |
Beispiel (cURL)
curl -X POST https://<IHRE-PROJEKT-URL>/functions/v1/convert \
-H "X-Typemail-Key: $TYPEMAIL_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"markdown": "# Hallo Welt!\nDas ist **Typemail**.\n\nGeneriert: {ai_content}",
"template_id": "<IHRE_VORLAGEN_UUID>",
"ai_service": {
"provider": "openai",
"model": "gpt-4o",
"prompt": "Schreibe eine kurze Begrüßung für unseren Newsletter",
"max_tokens": 200,
"temperature": 0.7
}
}'