Skip to content
Revox
Get started
API Reference
Auth Status

Retrieve

client.authStatus.retrieve(RequestOptionsoptions?): AuthStatusRetrieveResponse { authenticated }
GET/auth-status

Check if your API key is still valid.

ReturnsExpand Collapse
AuthStatusRetrieveResponse { authenticated }
authenticated: boolean

True if the API key is still valid.

Retrieve

import Revox from '@revoxai/sdk';

const client = new Revox({
  apiKey: process.env['REVOX_API_KEY'], // This is the default and can be omitted
});

const authStatus = await client.authStatus.retrieve();

console.log(authStatus.authenticated);
{
  "authenticated": true
}
Returns Examples
{
  "authenticated": true
}