Skip to content
StudyPlug API

Get current period usage summary

GET
/api/v1/usage

Returns today’s usage summary including request count, items generated, and remaining daily quota.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Usage summary

object
data
object
period
object
start
string format: date-time
end
string format: date-time
requests
integer
itemsGenerated
integer
tier
string
Allowed values: anonymous free pro agent
limits
object
perMinute
integer
perDay
integer
remainingToday
integer
meta
object
requestId
string format: uuid
generatedAt
string format: date-time
apiVersion
string
Allowed values: v1
cacheHit
boolean

401

Section titled “401 ”

Authentication required

RFC 7807 Problem Details

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string
retryAfter

Seconds to wait before retrying (present on 429 responses)

integer
Example
{
  "type": "https://api.studyplug.org/errors/unauthorized",
  "title": "API Key Required",
  "status": 401,
  "detail": "Provide a valid API key via the X-StudyPlug-Key header."
}

429

Section titled “429 ”

Rate limit exceeded

RFC 7807 Problem Details

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string
retryAfter

Seconds to wait before retrying (present on 429 responses)

integer
Example
{
  "type": "https://api.studyplug.org/errors/rate-limited",
  "title": "Rate Limit Exceeded",
  "status": 429,
  "detail": "You have exceeded 20 requests per minute. Please wait before retrying.",
  "instance": "/api/v1/skills",
  "retryAfter": 12
}

Headers

Section titled “Headers ”
Retry-After
integer

Seconds until rate limit resets

X-RateLimit-Limit
integer

Max requests per window

X-RateLimit-Remaining
integer
Allowed values: 0

Always 0 when rate limited