Get current-user Gateway quota percentages and raw token totals for inference clients

GET

/api/inference/v1/usage

curl --request GET \
  --url https://gateway.example.com/api/inference/v1/usage \
  --header 'Authorization: Bearer <token>'

• Your Gateway instance

Authorizations

• bearerAuth

Responses

200

Successful response

Media typeapplication/json

object

measuredAt

string format: date-time

enabled

required

boolean

api

required

object

active

boolean

percentage

required

number

<= 100

recoveryAt

required

string format: date-time

configured

required

boolean

subscription

required

object

5h

required

object

active

boolean

percentage

required

number

<= 100

recoveryAt

required

string format: date-time

configured

required

boolean

7d

required

object

active

boolean

percentage

required

number

<= 100

recoveryAt

required

string format: date-time

configured

required

boolean

30d

required

object

active

boolean

percentage

required

number

<= 100

recoveryAt

required

string format: date-time

configured

required

boolean

tokens

required

object

lifetime

required

integer

<= 9007199254740991

daily

required

Array<object>

object

date

required

string

/^\d{4}-\d{2}-\d{2}$/

tokens

required

integer

<= 9007199254740991

Example

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Example resource",
    "createdAt": "2024-01-01T12:00:00.000Z",
    "updatedAt": "2024-01-01T12:30:00.000Z"
  }
}

400

Bad request

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "details": [
    {
      "path": [
        "name"
      ],
      "message": "Required"
    }
  ]
}

401

Authentication required

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNAUTHORIZED",
  "message": "Authentication required"
}

403

Forbidden

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "FORBIDDEN",
  "message": "Insufficient permissions"
}

404

Not found

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "NOT_FOUND",
  "message": "Resource not found"
}

409

Conflict

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "CONFLICT",
  "message": "Resource already exists"
}

422

Unprocessable entity

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNPROCESSABLE_ENTITY",
  "message": "Request could not be processed"
}

500

Internal server error

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error"
}