API REST y generador de SDK de documentos a Markdown
Genera clientes sin clave en cURL, TypeScript, Python y Node.js para el endpoint OpenAPI 3.0.3 POST /api/v1/conversions.
Recursos RESTful v1 y especificación de respuestas
ToMarkdown ofrece tres recursos OpenAPI 3.0.3 (/openapi.json):
POST /api/v1/conversions (createConversion), GET /api/v1/formats (listFormats) y 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..."
}
- Negociación de contenido: Enviar
Accept: application/json(?format=json) para obtener el objetoConversion, oAccept: text/markdown(?format=markdown) para recibir directamente el flujo de descarga.md. - Cuotas y errores: Admite 22 extensiones de documentos, hojas de cálculo y marcado de hasta 10 MB (
15 req/minpor IP); devuelve un objeto estructurado{ "error": { "code", "message", "status" } }ante respuestas400,413,415(imágenes/SVG) y429.
Preguntas frecuentes
¿POST /api/v1/conversions requiere una clave de API?
No. Las conversiones públicas de documentos (.pdf, .docx, .xlsx, .ods, .numbers, .html, .xml, .csv) de hasta 10 MB son gratuitas y no requieren clave de API. Los archivos de imagen y SVG se rechazan (415) y el límite de frecuencia por IP (15 req/min) protege la disponibilidad del servicio.
¿Qué esquema JSON devuelve POST /api/v1/conversions?
Cuando se especifica Accept: application/json o ?format=json, POST /api/v1/conversions devuelve { filename, media_type, size_bytes, token_count, markdown }, donde markdown contiene el GFM extraído y token_count indica el número estimado de tokens.