API 概览

DocMap API 提供 REST 端点，用于通过 AI 驱动的模板从 PDF 文档中提取结构化数据。

基础 URL

所有 API 请求发送到：

https://api.docmap.io

所有版本化端点均以 /v1/ 为前缀。

身份认证

所有 /v1/* 端点都需要在 Authorization 头中包含 Bearer 令牌。您可以使用 API 密钥或 Firebase ID 令牌：

Authorization: Bearer dm_live_abc123def456ghi789jkl012mno345

API 密钥可以通过 控制面板 > 设置 > API 密钥 或通过 API 密钥端点创建和管理。详见身份认证指南。

内容类型

所有请求和响应体使用 JSON：

Content-Type: application/json

速率限制

提取请求受您计划的月度限额约束。使用 GET /v1/usage 端点查看当前用量。详见速率限制指南了解各计划配额。

端点汇总

方法	路径	描述
GET	/health	健康检查（无需认证）
POST	/v1/extractions/run	对 PDF 文档运行提取
GET	/v1/extractions	列出提取记录
DELETE	/v1/extractions/{id}	删除提取记录
GET	/v1/usage	获取当前计费周期的用量
POST	/v1/api-keys	创建新的 API 密钥
GET	/v1/api-keys	列出所有有效 API 密钥
DELETE	/v1/api-keys/{id}	吊销 API 密钥

健康检查

GET /health 是唯一不需要认证的端点。用于验证 API 是否可达。

curl

curl https://api.docmap.io/health

TypeScript

const res = await fetch('https://api.docmap.io/health')
const data = await res.json()
console.log(data) // { status: "ok" }

Python

import requests

res = requests.get("https://api.docmap.io/health")
print(res.json())  # {"status": "ok"}

响应：

{ "status": "ok" }

错误格式

所有错误响应遵循一致的结构：

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or expired API key."
  }
}

详见错误码参考获取完整的错误码列表及其含义。

OpenAPI 规范

完整的 OpenAPI 规范可用于工具集成和客户端生成：

• OpenAPI JSON: https://api.docmap.io/openapi.json
• Swagger UI: https://api.docmap.io/docs