REST API da documento a Markdown & generatore SDK
Genera client cURL, TypeScript, Python e Node.js senza chiave per l’endpoint OpenAPI 3.0.3 POST /api/v1/conversions.
Risorse RESTful v1 e specifica delle risposte
ToMarkdown espone tre risorse OpenAPI 3.0.3 (/openapi.json):
POST /api/v1/conversions (createConversion), GET /api/v1/formats (listFormats) e 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..."
}
- Negoziazione del contenuto: Passa
Accept: application/json(?format=json) per ricevere l’oggettoConversion, oppureAccept: text/markdown(?format=markdown) per uno stream di download.mddiretto. - Quote & errori: Supporta 22 estensioni di documenti, fogli di calcolo e markup fino a 10 MB (
15 req/minper IP); restituisce un oggetto strutturato{ "error": { "code", "message", "status" } }per i codici400,413,415(immagini/SVG) e429.
Domande frequenti
L’endpoint POST /api/v1/conversions richiede una chiave API?
No. Le conversioni pubbliche di documenti (.pdf, .docx, .xlsx, .ods, .numbers, .html, .xml, .csv) fino a 10 MB sono gratuite e non richiedono alcuna chiave API. I file immagine e SVG vengono rifiutati (415) e il rate limit per IP (15 req/min) tutela la disponibilità del servizio.
Quale schema JSON restituisce POST /api/v1/conversions?
Quando viene specificato Accept: application/json o ?format=json, POST /api/v1/conversions restituisce { filename, media_type, size_bytes, token_count, markdown }, dove markdown contiene il GFM estratto e token_count riporta il numero stimato di token.