メインコンテンツへスキップ

概要

Web2MD REST API を使うと、任意の Web ページや生の HTML をプログラムからクリーンな Markdown に変換できます。パイプラインの構築、コンテンツ取り込みの自動化、独自ツールへの Web2MD の組み込みなどに活用できます。
REST API には PRO プランが必要です。API キーは Web2MD ダッシュボードから生成してください。

機械可読な仕様

OpenAPI 仕様を使えば、クライアント SDK の自動生成や、Postman、Swagger UI、AI エージェントフレームワークへのインポートが可能です。

認証

すべてのリクエストで、Authorization ヘッダーに API キーを含める必要があります。
API キーは w2m_ で始まり、アカウントに紐付いています。

エンドポイント

POST https://web2md.org/api/v1/convert

リクエストボディ

urlhtml はどちらか一方のみを指定してください。両方を指定した場合、またはどちらも指定しなかった場合、リクエストは 400 エラーで失敗します。

オプション

レスポンス

成功時のレスポンスは次のとおりです。

レート制限

API リクエストは API キーごとに毎分 60 リクエストに制限されています。制限を超えると、API は 429 ステータスコードを返します。リセット時間を待ってから再試行してください。

エラーレスポンス

すべてのエラーレスポンスは次の形式に従います。

curl で URL を変換

curl で生の HTML を変換

JavaScript (fetch)

API キーはハードコードせず、環境変数に保存してください。たとえば Node.js では process.env.WEB2MD_API_KEY を使います。