Obtener uso

GET /v1/usage

Obtiene el uso actual de extracciones para el período de facturación del usuario autenticado. Usa este endpoint para monitorear el consumo y evitar alcanzar los límites del plan.

Pruébalo

Prueba este endpoint de forma interactiva en la Swagger UI.

Autorización requerida

Incluye tu clave API en el encabezado Authorization.

Solicitud

Encabezados

Encabezado	Valor	Requerido
Authorization	Bearer <token>	Sí

Este endpoint no acepta parámetros de consulta ni cuerpo de solicitud.

Ejemplos de código

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)")

Respuesta

Estado: 200 OK

El cuerpo de la respuesta está envuelto en un objeto data.

Campos

Campo	Tipo	Descripción
plan	string	El plan actual del usuario: free, starter, core o pro.
usage	number	Número de extracciones consumidas en el período de facturación actual.
limit	number	Número máximo de extracciones permitidas para el plan actual.
periodKey	string	Período de facturación actual en formato YYYY-MM.

Ejemplo

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

Errores

Estado	Código	Descripción
401	UNAUTHORIZED	Clave API / token faltante, inválido o expirado.