API REST & gerador de SDK de documento para Markdown
Gere clientes sem chave em cURL, TypeScript, Python e Node.js para o endpoint OpenAPI 3.0.3 POST /api/v1/conversions.
Recursos RESTful v1 e especificação de resposta
O ToMarkdown disponibiliza três recursos 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..."
}
- Negociação de conteúdo: Envie
Accept: application/json(?format=json) para receber o objetoConversion, ouAccept: text/markdown(?format=markdown) para baixar diretamente o stream.md. - Cotas & erros: Suporta 22 extensões de documentos, planilhas e marcação de até 10 MB (
15 req/minpor IP); retorna um objeto estruturado{ "error": { "code", "message", "status" } }nos códigos400,413,415(imagens/SVGs) e429.
Perguntas frequentes
O endpoint POST /api/v1/conversions exige chave de API?
Não. As conversões públicas de documentos (.pdf, .docx, .xlsx, .ods, .numbers, .html, .xml, .csv) de até 10 MB são gratuitas e dispensam chave de API. Arquivos de imagem e SVG são rejeitados (415), e o limite de taxa por IP (15 req/min) protege a disponibilidade do serviço.
Qual schema JSON o endpoint POST /api/v1/conversions retorna?
Quando Accept: application/json ou ?format=json é informado, POST /api/v1/conversions retorna { filename, media_type, size_bytes, token_count, markdown }, onde markdown contém o GFM extraído e token_count informa a contagem estimada de tokens.