HHyperspellHelp Center

Guide

Generate API Key

7 stepsAgent View (JSON)

Overview

API keys are your primary credential for programmatically accessing Hyperspell's AI services. Whether you're building a custom integration, testing the API in development, or deploying an application to production, you'll need a valid API key. Hyperspell allows you to generate and manage multiple API keys from your Developer Resources dashboard, each with a descriptive label to help you track which key is used for which purpose. This workflow walks you through creating a new key and preparing it for immediate use.

Before you begin

  • An active Hyperspell account with login credentials
  • Access to app.hyperspell.com
  • Permission to create API keys (typically available to all account owners and developers with appropriate roles)

Step by step

1
ClickAPI Keys

Navigate to the API Keys section by clicking the 'API Keys' option in the menu or navigation panel. This opens your API key management dashboard where you can view and create new keys.

Tip. If 'API Keys' is not immediately visible, it may be located under a Developer Resources, Settings, or Account menu. Check the menu structure in your Hyperspell account.
Step 1
2
ClickCreate API Key

Click the 'Create API Key' button to initiate the key generation workflow. This opens a form or modal where you'll configure the new key.

Step 2
3
Clickgeneric

Click on the label input field to activate it and prepare to enter a custom name for your API key. This generic click ensures the form is focused and ready for text input.

Tip. The label field is where you'll identify this key's purpose (e.g., 'Production Mobile App' or 'Development Testing'), making it easy to manage multiple keys.
Step 3
4
TypeLabel

Type a descriptive label for your API key in the 'Label' text field. Use a clear name that indicates the key's purpose or associated application (e.g., 'Mobile App v2' or 'Staging Environment').

Tip. Choose labels that your team will recognize months later. Avoid generic names like 'Key1' or 'Test'—instead use context like the environment, project name, or application it powers.
5
ClickCreate API Key

Click the 'Create API Key' button to finalize the key generation. Hyperspell will create the key and display it in a confirmation window, typically showing the full secret value only this one time.

Warning. After you close this confirmation window, you will not be able to retrieve the full API key value again. You must copy it immediately if you need it for integration setup.
Step 5
6
ClickCopy to clipboard

Click the 'Copy to clipboard' button to copy the newly generated API key to your system clipboard. You can then paste it into your application configuration, environment variables, or secure credential storage.

Tip. Paste the key immediately into a secure location (environment variables, secrets manager, configuration file) to avoid losing it. Test the paste operation right away to confirm the copy was successful.
Step 6
7
ClickClose

Click the 'Close' button to dismiss the key confirmation modal and return to the API Keys dashboard. Your newly created key will now appear in the list of active keys.

Step 7

Confirm it worked

  1. 1The API Keys section is displayed on app.hyperspell.com showing your list of existing keys
  2. 2A new API key is generated and displayed in a modal or confirmation dialog with the label you specified
  3. 3The API key string is copied to your clipboard (you can paste it in a text editor to confirm)
  4. 4The confirmation modal closes and you return to the API Keys list, where the new key appears in the inventory

Common issues

Keep reading

Creating and managing API keys  |  API Keys API Documentation  |  Google Cloud Documentation

Creating and managing API keys | API Keys API Documentation | Google Cloud Documentation # Creating and managing API keys This page explains how to create and manage API keys using the API Keys API.

cloud.google.com

Creating and managing API keys  |  API Keys API Documentation  |  Google Cloud Documentation

Creating and managing API keys | API Keys API Documentation | Google Cloud Documentation # Creating and managing API keys This page explains how to create and manage API keys using the API Keys API.

docs.cloud.google.com

Creating an API Key

Creating an API Key ### Oracle Cloud Infrastructure Documentation --- All Pages Was this article helpful? Updated 2026-01-22 Skip to main content Updated 2026-01-22 # Creating an API Key Crea

docs.oracle.com