Skip to main content

​
🔐 API Keys

Use your Nota AI API key to authenticate programmatic requests. To generate or manage keys, go to Settings → API Keys in the dashboard — see the API Keys settings guide.

​
🔐 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."
}