ドキュメント→Markdown REST API & SDKジェネレーター
OpenAPI 3.0.3準拠の POST /api/v1/conversions 向けに、APIキー不要のcURL、TypeScript、Python、Node.jsクライアントを生成します。
公開v1リソース: POST /api/v1/conversions (Multipart Form-Data · 最大10 MB · APIキー不要REST API)
ステートレスなメモリ内API — アップロードされたファイルは変換直後に破棄されます
Swagger UIを開く (/swagger)
RESTful v1リソース & レスポンス仕様
ToMarkdown は3つのOpenAPI 3.0.3リソース(/openapi.json)を提供しています:
POST /api/v1/conversions(createConversion)、GET /api/v1/formats(listFormats)、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..."
}
- コンテンツネゴシエーション:
Conversionオブジェクトを取得する場合はAccept: application/json(?format=json)を、.mdストリームとして直接受け取る場合はAccept: text/markdown(?format=markdown)を指定します。 - 上限 & エラー仕様: 最大10 MBまでのドキュメント・スプレッドシート・マークアップ計22拡張子に対応(IPあたり
15 req/min)。400、413、415(画像/SVG)、429発生時は構造化された{ "error": { "code", "message", "status" } }を返します。
よくある質問
POST /api/v1/conversions の利用にAPIキーは必要ですか?
いいえ。最大10 MBまでの公開ドキュメント変換(.pdf、.docx、.xlsx、.ods、.numbers、.html、.xml、.csv)は無料で、APIキーも不要です。画像およびSVGファイルは拒否され(415)、サービスの安定運用のためIP単位のレート制限(15 req/min)が適用されます。
POST /api/v1/conversions はどのようなJSONスキーマを返しますか?
Accept: application/json または ?format=json を指定すると、POST /api/v1/conversions は { filename, media_type, size_bytes, token_count, markdown } を返します。markdown には抽出されたGFMが、token_count には推定トークン数が格納されます。