Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.gistmag.co.uk/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Get detailed usage statistics for your API account, including request counts, credits used, and usage by time period.

​
Request

​
GET Request

curl "https://api.gistmag.co.uk/usage?api_key=your_api_key_here"

​
POST Request

curl -X POST https://api.gistmag.co.uk/usage \
  -H "Content-Type: application/json" \
  -d '{
    "api_key": "your_api_key_here"
  }'

​
Request Parameters

​
api_key
string
required
Your GistMag API key

​
Response

​
total_requests
number
Total number of API requests made
​
total_credits_used
number
Total credits consumed
​
requests_this_month
number
Number of requests made this month
​
credits_used_this_month
number
Credits used this month
​
subscription_tier
string
Your current subscription tier (free, pro, enterprise)
​
credits_remaining
number
Credits remaining in your account
​
usage_by_endpoint
object
Breakdown of usage by endpoint

​
Example Response

{
  "total_requests": 1523,
  "total_credits_used": 1523,
  "requests_this_month": 456,
  "credits_used_this_month": 456,
  "subscription_tier": "pro",
  "credits_remaining": 9544,
  "usage_by_endpoint": {
    "/generate": 1200,
    "/batch": 200,
    "/tts": 123
  }
}

​
Per-API-Key Usage

If you have multiple API keys, you can track usage per key. Each key’s usage is tracked independently.
Usage statistics are updated in real-time and reflect all requests made with your API keys.