Dokument-zu-Markdown REST API & SDK-Generator

Q: Benötigt POST /api/v1/conversions einen API-Schlüssel?

Nein. Öffentliche Dokumentkonvertierungen (.pdf, .docx, .xlsx, .ods, .numbers, .html, .xml, .csv) bis 10 MB sind kostenlos und erfordern keinen API-Schlüssel. Bild- und SVG-Dateien werden abgewiesen (415) und ein IP-basiertes Rate Limit (15 req/min) schützt die Verfügbarkeit.

Q: Welches JSON-Schema gibt POST /api/v1/conversions zurück?

Wird Accept: application/json oder ?format=json angegeben, liefert POST /api/v1/conversions { filename, media_type, size_bytes, token_count, markdown } zurück, wobei markdown das extrahierte GFM enthält und token_count die geschätzte Token-Anzahl angibt.

Öffentliche v1-Ressource: POST /api/v1/conversions (Multipart Form-Data · Max. 10 MB · Schlüssellose REST API)

Zustandslose In-Memory-API — hochgeladene Dateien werden sofort nach der Konvertierung verworfen

Swagger UI öffnen (/swagger)

Zielsprache / Laufzeitumgebung

Dateiname des Dokuments (.pdf / .docx / .xlsx)

Antwortformat

Generiertes API-Integrations-Snippet OpenAPI-3.0.3-konform · Schlüssellos

Interaktive Swagger UI OpenAPI 3.0.3 JSON (/openapi.json)

RESTful-v1-Ressourcen & Antwortspezifikation

ToMarkdown stellt drei OpenAPI-3.0.3-Ressourcen bereit (/openapi.json): POST /api/v1/conversions (createConversion), GET /api/v1/formats (listFormats) und GET /api/v1/health (getHealth).

HTTP/1.1 200 OK
Content-Type: application/json
X-RateLimit-Limit: 15
X-RateLimit-Remaining: 14

{
  "filename": "architecture-spec.pdf",
  "media_type": "application/pdf",
  "size_bytes": 248910,
  "token_count": 1842,
  "markdown": "# Architecture Specification\n\nConverted Markdown content..."
}

Content Negotiation: Übergeben Sie Accept: application/json (?format=json) für das Conversion-Objekt oder Accept: text/markdown (?format=markdown) für einen direkten .md-Download-Stream.
Limits & Fehlercodes: Unterstützt 22 Dokument-, Tabellen- und Markup-Endungen bis 10 MB (15 req/min pro IP); liefert strukturiertes { "error": { "code", "message", "status" } } bei 400, 413, 415 (Bilder/SVGs) und 429.

Häufig gestellte Fragen

Benötigt POST /api/v1/conversions einen API-Schlüssel?

Nein. Öffentliche Dokumentkonvertierungen (.pdf, .docx, .xlsx, .ods, .numbers, .html, .xml, .csv) bis 10 MB sind kostenlos und erfordern keinen API-Schlüssel. Bild- und SVG-Dateien werden abgewiesen (415) und ein IP-basiertes Rate Limit (15 req/min) schützt die Verfügbarkeit.

Welches JSON-Schema gibt POST /api/v1/conversions zurück?

Wird Accept: application/json oder ?format=json angegeben, liefert POST /api/v1/conversions { filename, media_type, size_bytes, token_count, markdown } zurück, wobei markdown das extrahierte GFM enthält und token_count die geschätzte Token-Anzahl angibt.