> ## Documentation Index
> Fetch the complete documentation index at: https://thehyperstack.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Platform Status

### Description

Tells you whether Hyperstack is up. It works without an API key.

If you send an API key, the response also has your organization's name and credit balance. This endpoint accepts `GET` only.

### Headers

**Authorization** `string`

Optional. Your API key: `Bearer YOUR_API_KEY`. Create a key in the Studio under **Settings → Developers**.

### Response Fields

**status** `string`

`"live"` when Hyperstack is up.

**message** `string`

A short status message, such as `"Hyperstack is live and running."`.

**applications** `object`

Reserved. Empty for now.

These fields are only in the response when you send an API key:

**success** `boolean`

`true` when the key is valid.

**account\_name** `string`

The display name of your organization.

**account\_id** `string`

Your organization's unique ID (its URL slug).

**credit\_balance** `number`

How many credits your organization has left.

**has\_sufficient\_credits** `boolean`

`true` when you can issue credentials now. When it is `false`, issuing returns `402` with the error code `low_balance`.

### Responses

```json 200 Without a key theme={null}
{
  "status": "live",
  "message": "Hyperstack is live and running.",
  "applications": {}
}
```

```json 200 With a key theme={null}
{
  "status": "live",
  "message": "Hyperstack is live and running.",
  "applications": {},
  "success": true,
  "account_name": "Acme Academy",
  "account_id": "acme-academy",
  "credit_balance": 1250,
  "has_sufficient_credits": true
}
```

```json 401 Invalid key theme={null}
{
  "status": "live",
  "message": "Hyperstack is live and running.",
  "applications": {},
  "success": false,
  "error": "Invalid token or organization not found",
  "error_code": "invalid_token"
}
```

```bash theme={null}
curl "https://api.thehyperstack.com/v1/info" \
  -H "Authorization: Bearer YOUR_API_KEY"
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.