Get API status

Authenticated self-check. A single call confirms the API is operational, your credentials are valid, and which account they resolve to (whoami). For credit balance and plan detail, use Get account usage.

GET /status

Typescript (SDK)

TypeScript

import { Crevio } from "@crevio/sdk";

const crevio = new Crevio({
  apiKey: process.env["CREVIO_API_KEY"] ?? "",
});

async function run() {
  const result = await crevio.status.get();

  console.log(result);
}

run();

200

{
  "api_version": "<string>",
  "authenticated": true,
  "account": {
    "id": "<string>",
    "name": "<string>"
  },
  "documentation_url": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

API key in the format: Bearer {api_token}

Response

200

application/json

API status and authenticated account context

object · enum<string> · required

Available options: status

status · enum<string> · required

Available options: operational

api_version · string · required

authenticated · boolean · required

account · object · required

Show child attributes

documentation_url · string · required

timestamp · string<date-time> · required