Image to Text

图片转文字 API,接入你的工作流。

面向开发者的图片转文字 API。提交图片,获取任务 ID,读取 Markdown 结果。CLI 和 MCP 共用 API 与图片积分。

Personal、Developer、Team 和 Enterprise 包含 API、CLI、MCP 和批量请求,各渠道共享图片积分。

curl https://imagetotext.dev/api/v1/convert \
  -H "Authorization: Bearer $IMAGETOTEXT_API_KEY" \
  -H "Idempotency-Key: example-conversion-0001" \
  -F "file=@screenshot.png;type=image/png" \
  -F "keepImages=false"

在终端或 AI Agent 中使用 Image to Text。

CLI、MCP 与账号共用 API、任务记录和图片积分。

Personal、Developer、Team 和 Enterprise 包含 API、CLI、MCP 和批量请求,各渠道共享图片积分。

安装客户端

需要 Node.js 20+。安装可下载的客户端包,再设置服务地址和产品 API Key。

npm install --global https://imagetotext.dev/downloads/imagetotext-client-0.1.0.tgz
下载 CLI + MCP 安装包(.tgz)
export IMAGETOTEXT_BASE_URL="https://imagetotext.dev"
# 请在终端或密钥管理工具中设置 IMAGETOTEXT_API_KEY。
imagetotext usage
imagetotext convert screenshot.png \
  --output document.md \
  --idempotency-key document-request-0001
imagetotext batch receipt.jpg notes.png \
  --idempotency-key batch-request-000001

命令返回便于脚本处理的 JSON;错误和自动生成的请求 ID 输出到 stderr。导出不覆盖已有文件,上传中断后请使用相同请求 ID 和文件重试。

image_to_text_convert提交一个 image 并返回任务 ID。
image_to_text_batch提交最多 10 个 image,返回逐文件处理记录。
image_to_text_get_job查询状态及分页 Markdown,每次最多 20,000 字符。
image_to_text_get_batch查询批次中每个文件的状态。
image_to_text_usage查询余额、月度用量与套餐权限。

可供 Agent 读取的接入资料: llms.txt / developers.md / OpenAPI

接口列表

POST/api/v1/convert提交一个 image,返回 HTTP 202 和任务 ID。
POST/api/v1/batches用重复的 files 字段提交最多 10 个 image,返回各文件处理记录。
GET/api/v1/jobs/{id}查询任务状态及已完成的 Markdown 结果。
GET/api/v1/batches/{id}查询批次内各文件状态,通过任务接口读取结果。
GET/api/v1/usage查询剩余额度及 UTC 当月转换用量。

提交、轮询、读取结果

将密钥设置到 IMAGETOTEXT_API_KEY 环境变量并仅在服务端使用。提交后每 5 秒查询任务或批次,直到状态为 success 或 failed。/api/v1 接口仅接受 API Key,不使用浏览器登录 Cookie。

# 提交响应示例,并非真实转换结果
{
  "code": 0,
  "message": "ok",
  "data": {
    "id": "image_…",
    "status": "pending",
    "fileName": "screenshot.png",
    "pages": 1,
    "quality": null
  }
}

curl https://imagetotext.dev/api/v1/jobs/JOB_ID \
  -H "Authorization: Bearer $IMAGETOTEXT_API_KEY"

成功任务返回 result.markdown、result.pages、result.images(文件名与 Base64 数据);失败任务返回错误码。批次响应不包含完整结果,请按任务分别读取。当前版本尚不提供向客户地址推送的 Webhook。

上传和请求限制

仅支持 JPG、PNG、WebP,每张 10 MB、2500 万像素以内。每批最多 10 张,总计 25 MB,提交前校验。账号写请求间隔 2 秒、读请求间隔 0.5 秒,429 返回 Retry-After。

重试与幂等处理

Idempotency-Key 使用 16-80 位字母、数字、下划线或连字符。网络中断后,使用相同文件、顺序、选项及密钥重试;内容不同返回 HTTP 409。批次可能部分提交,相同请求重试会尝试补交缺失文件;已失败任务需使用新密钥。

错误与计费

响应包含 code、message、data,code 为 0 表示成功。HTTP 401:密钥无效;402:额度不足;403:需有效付费套餐或 API 已关闭;404:任务不存在;409:幂等冲突;413:上传过大;429:频率限制;503:引擎未配置。标准转换每页 1 点,提交时预占,失败退回。

解析质量

上游质量评分用于辅助复核,不代表经过实测的识别准确率。引擎没有返回评分时,明确显示为未提供。 未提供评分时 API 返回 quality: null;真实评分格式为 score, scale: 5, source: "provider" 。当前版本尚不包含字词置信度和原文错误标注。