Получение использования

GET /v1/usage

Получение текущего использования извлечений для периода оплаты аутентифицированного пользователя. Используйте этот эндпоинт для мониторинга потребления и предотвращения превышения лимитов плана.

Попробуйте

Протестируйте этот эндпоинт интерактивно в Swagger UI.

Требуется авторизация

Укажите ваш API-ключ в заголовке Authorization.

Запрос

Заголовки

Заголовок	Значение	Обязательно
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-ключ / токен.