API概要

DocMap APIは、AIを活用したテンプレートを使用してPDFドキュメントから構造化データを抽出するためのRESTエンドポイントを提供します。

ベースURL

すべてのAPIリクエストは以下のURLに対して行います：

https://api.docmap.io

すべてのバージョン付きエンドポイントには /v1/ プレフィックスが付きます。

認証

すべての /v1/* エンドポイントには、Bearerトークンを含む Authorization ヘッダーが必要です。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