Rivier/ Reference/ models

What the project has used of the model service

get/models/v1/usage

What the project has used of the model service: its token allowances this period, how far it is into its spending limits for today and this month, as a share, and today's calls, tokens and cost by route and purpose.

Before you call

Credential
Authorization: Bearer $KEY
Scope
models:read
Graphql
Query.modelsUsageGet
Sdk
models.usage.get
Cli
models usage get

Responses

  • 200application/json
    Success
    • objectusagerequired
    • atstringrequired
    • serviceobjectrequired
      • onbooleanrequired
      • messagestring
    • tokenslist of objectrequired
      • meterstringrequired
      • labelstringrequired
      • periodstringrequired
      • resetsAtstring or nullrequired
      • includednumber or nullrequired
      • usednumberrequired
      • remainingnumber or nullrequired
    • budgetobjectrequired
      • dayobjectrequired
        • usednumber or nullrequired
        • resetsAtstringrequired
      • monthobjectrequired
        • usednumber or nullrequired
        • resetsAtstringrequired
    • todayobjectrequired
      • costUsdnumberrequired
      • routeslist of objectrequired
        • routestringrequired
        • purposestringrequired
        • callsnumberrequired
        • tokensInnumberrequired
        • tokensOutnumberrequired
        • costUsdnumberrequired
  • 400application/json
    The request was malformed
    • errorstringrequired
    • messagestring
  • 401application/json
    No valid credential
    • errorstringrequired
    • messagestring
  • 403application/json
    The credential lacks the scope, origin or address
    • errorstringrequired
    • messagestring
  • 429application/json
    Over the key's rate limit; see Retry-After
    • errorstringrequired
    • messagestring

This page as Markdown