Skip to content
Get started

Retrieve

auth_status.retrieve() -> AuthStatusRetrieveResponse
GET/auth-status

Check if your API key is still valid.

ReturnsExpand Collapse
class AuthStatusRetrieveResponse:
authenticated: bool

True if the API key is still valid.

Retrieve

import os
from revox import Revox

client = Revox(
    api_key=os.environ.get("REVOX_API_KEY"),  # This is the default and can be omitted
)
auth_status = client.auth_status.retrieve()
print(auth_status.authenticated)
{
  "authenticated": true
}
Returns Examples
{
  "authenticated": true
}