APIドキュメント
Image to Markdown API
テキスト抽出とレイアウト保持機能付きで画像ファイルをMarkdown形式に変換
概要
Image to Markdown APIは、テキスト抽出とレイアウト保持機能付きで画像ファイルをMarkdown形式に変換します。 統一されたJSONリクエスト形式を使用し、URL参照またはbase64エンコードされた画像データを受け入れます。
認証
APIは以下の認証方法をサポートしています:
- APIキー: クエリパラメータとしてAPIキーを渡す
?key=YOUR_API_KEY
画像をMarkdownに変換
テキスト抽出とレイアウト保持機能付きで画像ファイルをMarkdown形式に変換します。
リクエスト
POST /api/image-to-markdownパラメータ:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
| document | object | はい | ドキュメントオブジェクト |
| document.type | string | はい | 固定値 "image_url" |
| document.image_url | string | はい | 画像URLまたはbase64データ |
| filename | string | いいえ | ファイル名(base64データの場合推奨) |
| key | string | いいえ | APIキー(クエリパラメータ、ログインユーザーにはオプション) |
例:
画像URLを使用:
curl -X POST "https://llmocr.com/api/image-to-markdown?key=YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"document": {
"type": "image_url",
"image_url": "https://llmocr.com/image.jpg"
}
}'Base64画像データを使用:
curl -X POST "https://llmocr.com/api/image-to-markdown?key=YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"document": {
"type": "image_url",
"image_url": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEA..."
},
"filename": "my-image.jpg"
}'レスポンス
パラメータ:
| パラメータ | 型 | 説明 |
|---|---|---|
| id | string | データベースレコードID |
| filename | string | ファイル名 |
| content | string | 画像から抽出された完全なMarkdownコンテンツ |
| format | string | 出力形式、固定値 "markdown" |
| timestamp | number | 処理完了タイムスタンプ |
| payload | string | APIエンドポイントURL |
例:
{
"id": "67890",
"filename": "image.jpg",
"content": "# Title from Image\n\nExtracted text content in Markdown format...\n\n- Bullet point 1\n- Bullet point 2\n\n| Column 1 | Column 2 |\n|----------|----------|\n| Data 1 | Data 2 |",
"format": "markdown",
"timestamp": 1640995200000,
"payload": "https://llmocr.com/api/image-to-markdown?key=YOUR_API_KEY"
}