API REST & générateur SDK Document vers Markdown
Générez des clients sans clé en cURL, TypeScript, Python et Node.js pour l’endpoint OpenAPI 3.0.3 POST /api/v1/conversions.
Ressources RESTful v1 & spécification des réponses
ToMarkdown expose trois ressources OpenAPI 3.0.3 (/openapi.json) :
POST /api/v1/conversions (createConversion), GET /api/v1/formats (listFormats) et 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..."
}
- Négociation de contenu : Passez
Accept: application/json(?format=json) pour obtenir l’objetConversion, ouAccept: text/markdown(?format=markdown) pour un flux de téléchargement.mddirect. - Quotas & erreurs : Prend en charge 22 extensions de documents, tableurs et balisage jusqu’à 10 MB (
15 req/minpar IP) ; renvoie un objet structuré{ "error": { "code", "message", "status" } }sur les codes400,413,415(images/SVG) et429.
Questions fréquentes
L’endpoint POST /api/v1/conversions requiert-il une clé API ?
Non. Les conversions publiques de documents (.pdf, .docx, .xlsx, .ods, .numbers, .html, .xml, .csv) jusqu’à 10 MB sont gratuites et ne demandent aucune clé API. Les images et fichiers SVG sont rejetés (415) et une limite de débit par IP (15 req/min) protège la disponibilité du service.
Quel schéma JSON renvoie POST /api/v1/conversions ?
Lorsque Accept: application/json ou ?format=json est précisé, POST /api/v1/conversions renvoie { filename, media_type, size_bytes, token_count, markdown }, où markdown contient le GFM extrait et token_count indique le nombre estimé de tokens.