logo
APICheck Usage

Check Usage

Paperguide Usage API for checking current API usage, remaining quota, and plan limits in your integration.

curl -X GET "https://api.paperguide.ai/v1/usage" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY"
{
  "monthly_used": 124,
  "monthly_quota": 1000,
  "rate_limit_per_minute": 30
}
curl -X GET "https://api.paperguide.ai/v1/usage" \
  -H "x-api-key: pg_api_example_9xmk7q2r"
{
  "monthly_used": 4,
  "monthly_quota": 10,
  "rate_limit_per_minute": 5
}
GET
/usage
GET
API Key (header: x-api-key)
x-api-keystring
Required

API key (sent in header)

Request Preview
Response

Response will appear here after sending the request

Authentication

header
x-api-keystring
Required

API Key for authentication. Provide your API key in the header.

Responses

monthly_usedinteger
Required

Number of requests or units used in the current billing period.

monthly_quotainteger
Required

Monthly quota for the account. A value of -1 means there is no monthly quota limit.

rate_limit_per_minuteinteger
Required

Allowed request rate per minute.

Endpoint overview

Check your current API usage for the billing period, including your quota and per-minute rate.

Add your API key to the x-api-key header on every request. Create API keys in Settings > API Keys in the Paperguide dashboard.

x-api-key: pg_api_example_9xmk7q2r

Method and path

GET /v1/usage

Send requests to the Paperguide API base URL:

https://api.paperguide.ai/v1

Request example

Response example

Response fields

monthly_usedinteger
Required

Number of API calls your account has used in the current billing period.

monthly_quotainteger
Required

Monthly API call quota for your plan.

rate_limit_per_minuteinteger
Required

Maximum number of requests your plan allows per minute.

What monthly_quota = -1 means

A monthly_quota value of -1 means your plan does not have a monthly quota limit.

For Enterprise, usage is billed based on how many API calls you make instead of a fixed monthly quota. Contact us for Enterprise access. Enterprise billing is $0.01 per API call.

How usage relates to rate limits and quotas

Your plan sets two limits: a monthly quota and a per-minute request limit. If you go over either limit, the API returns 429 Too Many Requests.

For Enterprise, usage reflects pay-per-call billing instead of a fixed monthly quota. Enterprise also supports up to 50 papers per request.

Error responses

The API returns JSON errors when a request fails.

StatusMeaning
400Invalid request parameters
401Missing or invalid API key
429Rate limit or monthly quota exceeded
500Internal server error
Was this page helpful?

Last updated 2 days ago

Built with Documentation.AI