> ## Documentation Index
> Fetch the complete documentation index at: https://hyperbolic.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Account Management
> Create and configure your Hyperbolic account, API keys, and SSH keys
## Plan
This is where you view and manage your plan. Your plan determines your level of access to the platform and your API rate limits. There is never a monthly commitment to maintaining a plan. For all plans, you purchase “compute credits” which sit as a balance on your account. You use your compute credit balance for services on the platform, e.g. launching GPU instances and storage volumes, and creating storage volumes.
We offer three plan tiers: free, pro, and enterprise.
**Free tier:** The default plan for new accounts. There is no minimum spend amount required. You may not launch GPU instances nor storage volumes with a free-tier account. API rate limits are restrictive.
**Pro:** You must deposit at least \$5 one-time to automatically become a pro-tier user. You may access all features of the platform including GPU instances and storage volumes. Your API rate limits are much higher.
**Enterprise:** For any custom plan, please reach out to us.
## Billing
This is where you view and edit your billing details.
We do not keep your payment method on file unless you have chosen to store a card by enabling [Auto Top-Up](/docs/general/auto-top-up).
## API Keys
This is where you create and manage your API Keys.
After creation, API keys cannot be viewed or recovered - make sure you copy and save your key immediately after creating it!
API keys may be revoked at any time. An account may have any number of API keys.
## SSH Keys
Manage your SSH public keys under **Settings > SSH Keys** in the [dashboard](https://app.hyperbolic.ai/settings/ssh-keys). An SSH key is required to provision GPU instances.
Only add your SSH public key (for example, `id_ed25519.pub`). Never upload a private key.
You can save multiple SSH keys to your account. For each key, you can:
* **Add** a key by pasting it or dragging and dropping your `.pub` file. Hyperbolic pre-fills the name from the key's comment, and you can change it to something you'll recognize.
* **Rename** a key at any time.
* **Copy** a key's public key text.
* **Delete** a key that isn't attached to a live instance.
Hyperbolic rejects a key that's already saved on your account. The comparison ignores the key's comment, so the same key with a different comment counts as a duplicate.
### Choose a key when you launch
When you rent an instance, you select one of your saved keys in the **Who can SSH into this instance?** step. You can also paste a new key there, and Hyperbolic saves it to your account. If you have only one saved key, it's selected automatically. The instance is provisioned with the selected key, so keep the matching private key on your machine or you may lose access to the instance.
### Attach multiple keys to an instance
Some regions let you attach more than one SSH key to an instance, so several people can connect with their own keys. After you select a key, an **Add another key** button appears below it when the region you chose supports multiple keys. Click it to pick another saved key or paste a new one. Click **Remove** to detach a key before you launch.
If you don't see **Add another key**, that region accepts one key per instance. If you switch from a multi-key region to a single-key region, Hyperbolic keeps only the first key you selected. An API request that attaches more than one key in a single-key region returns the `MULTIPLE_SSH_PUBLIC_KEYS_NOT_SUPPORTED_FOR_REGION` error.
If a rental request through the API doesn't specify a key, Hyperbolic attaches your newest saved key. Under an Organization, Hyperbolic uses the Organization's newest key. To choose keys yourself, pass their IDs (from `GET /v2/ssh-keys`) in the `sshPublicKeyIds` array when you create a rental.
### Change keys on a running instance
You can add or remove SSH keys on a running instance without relaunching it. Use this to replace a lost key, fix a launch with the wrong key, or give a teammate access. Changes reach every node in about 20 seconds, and the instance doesn't reboot.
Open the instance's details page and find the **SSH Access** section, which lists the keys attached to the instance.
* **Add a saved key**: click **Add key**, then select a saved key that isn't attached yet.
* **Add a new key**: click **Add key**, then paste a new public key. Hyperbolic saves the key to your account and attaches it to the instance.
* **Remove a key**: click **Remove** next to the key.
An instance must keep at least one key. When only one key is attached, **Remove** is disabled. Add another key first, then remove the old one.
If you don't see **Add key** or **Remove**, the instance's region doesn't support live key changes yet, or you don't have permission to make them. Bare metal rentals don't support live key changes. Under an [Organization](/docs/general/organizations#ssh-keys), any member can add a key, but only admins and the member who created the rental can remove one.
To change keys through the API, call `POST /v2/on-demand/rentals/ssh-keys/attach` or `POST /v2/on-demand/rentals/ssh-keys/detach` with the rental ID and SSH key ID:
```bash theme={null}
curl -X POST https://api.hyperbolic.ai/v2/on-demand/rentals/ssh-keys/attach \
-H "Authorization: Bearer $HYPERBOLIC_API_KEY" \
-H "Content-Type: application/json" \
-d '{"rentalId": "", "sshPublicKeyId": }'
```
Detaching the last key returns `CANNOT_DETACH_LAST_RENTAL_SSH_KEY`. A rental that can't change keys returns `RENTAL_SSH_KEY_UPDATE_NOT_SUPPORTED`. If a change fails with `FAILED_TO_UPDATE_RENTAL_SSH_KEYS`, you can safely retry it.
### Keys in use
The key list shows how many live instances use each key. You can't delete a key while it's attached to a live instance. Terminate the instance first, then delete the key.
### Manage keys with the API
You can also manage SSH keys through the Hyperbolic API with these endpoints. See the API Reference for full request and response schemas.
| Method | Endpoint | Description |
| - | - | - |
| `GET` | `/v2/ssh-keys` | List your SSH keys |
| `POST` | `/v2/ssh-keys` | Add an SSH key |
| `POST` | `/v2/ssh-keys/update` | Rename an SSH key |
| `POST` | `/v2/ssh-keys/delete` | Delete an SSH key |
| `GET` | `/v2/ssh-keys/rental` | List the SSH keys attached to a rental |
| `POST` | `/v2/on-demand/rentals/ssh-keys/attach` | Attach a saved SSH key to a running rental |
| `POST` | `/v2/on-demand/rentals/ssh-keys/detach` | Detach an SSH key from a running rental |
For example, add a key with an optional name:
```bash theme={null}
curl -X POST https://api.hyperbolic.ai/v2/ssh-keys \
-H "Authorization: Bearer $HYPERBOLIC_API_KEY" \
-H "Content-Type: application/json" \
-d "{\"publicKey\": \"$(cat ~/.ssh/id_ed25519.pub)\", \"name\": \"Work laptop\"}"
```
Adding a duplicate key returns the `SSH_PUBLIC_KEY_ALREADY_EXISTS` error. When your API key belongs to an [Organization](/docs/general/organizations#ssh-keys), these endpoints manage the Organization's SSH keys instead of your personal keys.
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.