사용량 조회

GET /v1/usage

인증된 사용자의 청구 기간에 대한 현재 추출 사용량을 조회합니다. 이 엔드포인트를 사용하여 사용량을 모니터링하고 플랜 한도 초과를 방지하세요.

사용해 보기

이 엔드포인트를 Swagger UI에서 대화형으로 테스트할 수 있습니다.

인증 필요

Authorization 헤더에 API 키를 포함하세요.

요청

헤더

헤더	값	필수
Authorization	Bearer <token>	예

이 엔드포인트는 쿼리 파라미터나 요청 본문이 필요하지 않습니다.

코드 예제

curl

curl https://api.docmap.io/v1/usage \
  -H "Authorization: Bearer dm_live_abc123def456ghi789jkl012mno345"

TypeScript

const apiKey = process.env.DOCMAP_API_KEY

const response = await fetch('https://api.docmap.io/v1/usage', {
  headers: { 'Authorization': `Bearer ${apiKey}` },
})

const { data } = await response.json()
console.log(`${data.usage} / ${data.limit} extractions used (${data.plan} plan)`)

Python

import requests

api_key = "dm_live_abc123def456ghi789jkl012mno345"

response = requests.get(
    "https://api.docmap.io/v1/usage",
    headers={"Authorization": f"Bearer {api_key}"},
)

data = response.json()["data"]
print(f"{data['usage']} / {data['limit']} extractions used ({data['plan']} plan)")

응답

상태: 200 OK

응답 본문은 data 객체로 감싸져 있습니다.

필드

필드	타입	설명
plan	string	사용자의 현재 플랜: free, starter, core, 또는 pro.
usage	number	현재 청구 기간에 소비된 추출 횟수.
limit	number	현재 플랜에서 허용되는 최대 추출 횟수.
periodKey	string	YYYY-MM 형식의 현재 청구 기간.

예시

{
  "data": {
    "plan": "starter",
    "usage": 142,
    "limit": 500,
    "periodKey": "2024-11"
  }
}

오류

상태	코드	설명
401	UNAUTHORIZED	누락, 유효하지 않거나 만료된 API 키 / 토큰.