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"
import requests
import json
url = "https://api.paperguide.ai/v1/usage"
headers = {
"Content-Type": "application/json",
"x-api-key": "YOUR_API_KEY"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://api.paperguide.ai/v1/usage", {
method: "GET",
headers: {
"Content-Type": "application/json",
"x-api-key": "YOUR_API_KEY"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://api.paperguide.ai/v1/usage", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("x-api-key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.paperguide.ai/v1/usage')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['x-api-key'] = 'YOUR_API_KEY'
response = http.request(request)
puts response.body
{
"monthly_used": 124,
"monthly_quota": 1000,
"rate_limit_per_minute": 30
}
{
"error": "invalid_request",
"message": "The request was invalid or missing required parameters."
}
{
"error": "unauthorized",
"message": "Missing or invalid API key."
}
{
"error": "rate_limited",
"message": "Rate limit exceeded. Please try again later."
}
{
"error": "internal_error",
"message": "An unexpected server error occurred."
}
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
}
/usage
API key (sent in header)
Request Preview
Response
Response will appear here after sending the request
Authentication
API Key for authentication. Provide your API key in the header.
Responses
Number of requests or units used in the current billing period.
Monthly quota for the account. A value of -1 means there is no monthly quota limit.
Allowed request rate per minute.
Short machine-readable error code.
Human-readable error message.
Short machine-readable error code.
Human-readable error message.
Short machine-readable error code.
Human-readable error message.
Short machine-readable error code.
Human-readable error message.
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
Number of API calls your account has used in the current billing period.
Monthly API call quota for your plan.
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.
| Status | Meaning |
|---|---|
400 | Invalid request parameters |
401 | Missing or invalid API key |
429 | Rate limit or monthly quota exceeded |
500 | Internal server error |
Last updated 2 days ago
Built with Documentation.AI