Skip to main content

​
🔐 API Keys

The API Keys page enables developers and QA testers to integrate Nota AI with other systems through secure, token-based authentication.

​
🔍 Features of the API Keys Page

​
👁 Viewing API Keys

  • See all previously generated API keys in a list.
  • Each key displays the following metadata:
    • Name: A user-defined label for easier identification
    • Created Date: When the key was generated
    • Created By: The user who created the key
    • Actions: Revoke a key if needed
⚠️ For security reasons, the full key is shown only once at the time of creation.
API key dashboard

​
➕ Generating a New API Key

To create a new API key:
  1. Navigate to the API Keys page in the Nota AI dashboard
  2. Click “Add New Key” in the top right corner
  3. Enter a name for the key
  4. Click “Create API Key”
⚠️ Make sure to copy and store the key securely—it’s only visible once.
API key creation modal

​
🔐 Using API Keys for Authentication

Once you’ve created a key, use it to authenticate API calls.

​
Request Header

{
  "Authorization": "Bearer YOUR_API_KEY",
  "Content-Type": "application/json"
}

​
Request Parameters

ParameterTypeDescription
dataarrayList of workflow descriptions specifying the tests to execute
environment_namestringName of the environment where the workflow should run (e.g., staging, production)
suite_namestringLogical grouping name for organizing the workflows

​
Request Body Format:

{
  "data": [
    "Check button functionality across screen sizes",
    "Ensure accessibility for images and contrast",
    "Test button response under rapid clicks"
  ],
  "environment_name": "development nota ai",
  "suite_name": "api suite name"
}

​
Response Example

{
  "status": "success",
  "message": "Request received. Your workflow execution has been initiated."
}