API keys provide programmatic access to NeuroAI. If you’re using the web interface, authentication is handled automatically.

API Keys

API keys provide secure, programmatic access to NeuroAI platform resources. They enable authentication for automated workflows, integrations, and applications without requiring manual login credentials.

What are API Keys?

API keys are long-lived access tokens that authenticate requests to NeuroAI services. They act as unique identifiers that verify your identity and determine what actions you can perform within the platform.

Key Benefits

Seamless Integration

Connect NeuroAI with external tools and services effortlessly

Automated Access

Enable scripts, CI/CD pipelines, and automated workflows

Granular Permissions

Control access levels through role-based permissions

Secure Communication

Authenticate without exposing user credentials

Getting Started

Prerequisites

To create and manage API keys:

Active NeuroAI account
Administrator or API Key Manager role
Access to NeuroAI dashboard

Creating an API Key

Dashboard
API

Via Dashboard

Navigate to Settings → Users and Teams
Select API Keys from the menu
Click Create API Key button
Configure your key:
- Name: Descriptive identifier (e.g., “Production CI/CD”)
- Description: Document purpose and usage
- Role: Select appropriate access level
- Expiration (optional): Set expiration date
Click Create

Copy and securely store your API key immediately—it will only be displayed once!

Via API

Create an API key programmatically:

curl -X POST "https://api.neuroai.com/v1/api-keys" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-api-key",
    "description": "API key for production deployment",
    "role": "developer",
    "expiration": "2026-12-31T23:59:59Z"
  }'

API Key Types

Personal Keys

Individual user keys for personal projects and testing

Team Keys

Shared keys for production applications and team integrations

Service Keys

Dedicated keys for service-to-service authentication

Personal API Keys

Personal keys are specific to individual NeuroAI users and inherit the creator’s permissions. Use Cases:

Personal projects and experiments
Development and testing environments
Individual automation scripts

Characteristics:

Tied to single user account
Cannot exceed creator’s permission level
Auto-revoked when user account is deactivated

Team API Keys

Shared keys that authenticate requests on behalf of a team or organization. Use Cases:

Production applications
Team-wide integrations
CI/CD pipelines
Shared development resources

Service API Keys

Dedicated keys for service-to-service authentication and data ingestion. Use Cases:

Telemetry data transmission
Webhook endpoints
Third-party service integrations
Monitoring and analytics services

Authentication

Header (Recommended)
Query Parameter

Bearer Token Authentication

Include your API key in the Authorization header:

curl "https://api.neuroai.com/v1/agents" \
  -H "Authorization: Bearer YOUR_API_KEY"

Or using X-API-Key header:

curl "https://api.neuroai.com/v1/agents" \
  -H "X-API-Key: YOUR_API_KEY"

URL Parameter

Include the API key as a URL parameter:

curl "https://api.neuroai.com/v1/agents?api_key=YOUR_API_KEY"

Not recommended for production. Query parameters may be logged in server logs and browser history.

Integration Examples

Python

Integrate with Python applications

Node.js

Integrate with Node.js applications

cURL

Test with command line

Environment Setup

Configure API keys in your environment:

# .env file
NEUROAI_API_KEY=your_api_key_here
NEUROAI_API_BASE=https://api.neuroai.com/v1
MODEL_TO_USE=openai/gpt-4o

Python Example

import os
import requests

# Load API key from environment
api_key = os.getenv('NEUROAI_API_KEY')

# Make authenticated request
headers = {
    'Authorization': f'Bearer {api_key}',
    'Content-Type': 'application/json'
}

response = requests.get(
    'https://api.neuroai.com/v1/agents',
    headers=headers
)

print(response.json())

Node.js Example

const axios = require('axios');

const apiKey = process.env.NEUROAI_API_KEY;

const client = axios.create({
  baseURL: 'https://api.neuroai.com/v1',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'Content-Type': 'application/json'
  }
});

// Make authenticated request
client.get('/agents')
  .then(response => console.log(response.data))
  .catch(error => console.error(error));

cURL Example

# Set API key as environment variable
export NEUROAI_API_KEY="your_api_key_here"

# Make authenticated request
curl "https://api.neuroai.com/v1/agents" \
  -H "Authorization: Bearer $NEUROAI_API_KEY"

Permissions and Roles

Role-Based Access

Assign predefined roles with specific permission sets

Custom Permissions

Create custom roles for fine-grained access control

Available Roles

Role	Permissions	Use Case
Viewer	Read-only access	Monitoring, analytics, reporting
Developer	Create and modify agents	Development, testing
Administrator	Full access including user management	Production deployments
API Manager	Manage API keys and integrations	DevOps, security

Custom Permissions

For fine-grained control, create custom roles:

{
  "role_name": "custom-deployment-role",
  "permissions": {
    "agents": ["create", "read", "update"],
    "workflows": ["create", "read", "execute"],
    "deployments": ["create", "read", "update", "delete"],
    "users": ["read"]
  }
}

Managing API Keys

Viewing API Keys

List all API keys associated with your account:

curl "https://api.neuroai.com/v1/api-keys" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Updating API Keys

Modify API key properties (name, description, permissions):

curl -X PATCH "https://api.neuroai.com/v1/api-keys/{key_id}" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Key Name",
    "description": "Updated description",
    "role": "administrator"
  }'

Rotating API Keys

Regular key rotation enhances security:

curl -X POST "https://api.neuroai.com/v1/api-keys/{key_id}/rotate" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

This generates a new key while invalidating the old one.

Revoking API Keys

Delete an API key when it’s no longer needed:

curl -X DELETE "https://api.neuroai.com/v1/api-keys/{key_id}" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Via Dashboard:

Navigate to Settings → API Keys
Locate the key to revoke
Click Delete or Revoke
Confirm the action

Security Best Practices

Storage & Handling

Secure storage and environment configuration

Access Control

Principle of least privilege and role management

Key Rotation

Regular rotation schedule and automated processes

Monitoring

Usage tracking and suspicious activity alerts

Storage and Handling

✅ Do
❌ Don't

Store keys in environment variables
Use secrets management systems (Vault, AWS Secrets Manager)
Restrict access to authorized personnel only
Use .gitignore for .env files
Implement git-secrets to prevent commits

Access Control

Principle of Least Privilege: Assign minimum necessary permissions
Separate by Environment: Different keys for dev, staging, production
Regular Audits: Review usage and permissions quarterly
Monitor Activity: Track for suspicious patterns

Key Rotation

Configure automatic expiration and rotation:

{
  "expiration": "2026-12-31T23:59:59Z",
  "rotation_policy": {
    "enabled": true,
    "days": 90
  }
}

Additional Security Measures

Referrer Restrictions

Limit API key usage to specific domains or IP addresses:

{
  "allowed_referrers": [
    "https://yourdomain.com/*",
    "https://app.yourdomain.com/*"
  ],
  "allowed_ips": [
    "203.0.113.0/24",
    "198.51.100.50"
  ]
}

Rate Limiting

Protect against abuse with rate limits:

{
  "rate_limit": {
    "requests_per_minute": 100,
    "requests_per_hour": 5000
  }
}

Hide Credentials

Prevent keys from being forwarded to upstream services:

{
  "hide_credentials": true
}

Monitoring and Logging

Usage Tracking

Monitor request volume and patterns

Audit Logs

Access comprehensive security logs

Alerts

Get notified of suspicious activity

Access Audit Logs

curl "https://api.neuroai.com/v1/api-keys/{key_id}/audit-log" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Configure Alerts

Monitor for:

Unusual request patterns
Multiple failed authentication attempts
Requests from unexpected locations
Access to sensitive endpoints

Troubleshooting

401 Unauthorized

Common causes:

API key is incorrect or revoked
Missing or malformed Authorization header
Key lacks required permissions

Solution: Verify header format and key validity:

curl "https://api.neuroai.com/v1/auth/verify" \
  -H "Authorization: Bearer YOUR_API_KEY"

403 Forbidden

Common causes:

API key lacks required permissions
Resource access is restricted
Referrer restrictions are active

Solution: Review and update key permissions or use a key with appropriate access level.

429 Too Many Requests

Common causes:

Rate limit exceeded
Too many concurrent requests

Solution:

Implement exponential backoff retry logic
Review and optimize request patterns
Consider upgrading your plan for higher limits

Expired API Key

Common causes:

Key has reached expiration date
Key was manually revoked

Solution: Create a new API key or extend expiration if possible.

Testing API Keys

Verify your API key is working:

curl "https://api.neuroai.com/v1/auth/verify" \
  -H "Authorization: Bearer YOUR_API_KEY"

Expected response:

{
  "valid": true,
  "key_id": "key_abc123",
  "name": "Production Key",
  "role": "developer",
  "expires_at": "2026-12-31T23:59:59Z"
}

API Reference

Create API Key

POST /v1/api-keys

List API Keys

GET /v1/api-keys

Update API Key

PATCH /v1/api-keys/key_id

Delete API Key

DELETE /v1/api-keys/key_id

Endpoints Summary

Endpoint	Method	Description
`/v1/api-keys`	POST	Create a new API key
`/v1/api-keys`	GET	List all API keys
`/v1/api-keys/{key_id}`	GET	Get API key details
`/v1/api-keys/{key_id}`	PATCH	Update API key
`/v1/api-keys/{key_id}/rotate`	POST	Rotate API key
`/v1/api-keys/{key_id}`	DELETE	Delete API key
`/v1/auth/verify`	GET	Verify API key validity

Migration Guide

From Legacy Auth
From Other Platforms

From Username/Password

Create API keys for all service accounts
Update applications to use API key authentication
Test thoroughly in staging environment
Deploy to production with gradual rollout
Monitor for issues during transition
Deactivate legacy credentials after successful migration

FAQ

How many API keys can I create?

There is no strict limit on the number of API keys per account. However, we recommend creating only the keys you need and following the principle of least privilege.

Can I use the same key across multiple environments?

While technically possible, it’s strongly discouraged. Use separate API keys for development, staging, and production environments for better security and access control.

What happens if my API key is compromised?

Immediately revoke the compromised key through the dashboard or API. Create a new key with different credentials and update all applications. Review audit logs to assess potential unauthorized access.

Do API keys expire?

By default, API keys do not expire unless you explicitly set an expiration date during creation. For enhanced security, consider setting expiration dates and implementing regular key rotation.

Can I recover a deleted API key?

No, deleted API keys cannot be recovered. You must create a new API key if one is accidentally deleted.

How do I know which permissions my API key needs?

Start with minimal permissions required for your use case. Test thoroughly and add permissions as needed. Review the permissions documentation for detailed information about each role.

Support

Documentation

Comprehensive guides and tutorials

Support Portal

Submit tickets and get help

API Status

Check real-time API status

Community

Join the discussion

Last Updated: January 2026
API Version: v1
Product: NeuroAI Platform

API documentation

​API Keys

​What are API Keys?

​Key Benefits

Seamless Integration

Automated Access

Granular Permissions

Secure Communication

​Getting Started

​Prerequisites

​Creating an API Key

​Via Dashboard

​Via API

​API Key Types

Personal Keys

Team Keys

Service Keys

​Personal API Keys

​Team API Keys

​Service API Keys

​Authentication

​Bearer Token Authentication

​URL Parameter

​Integration Examples

Python

Node.js

cURL

​Environment Setup

​Python Example

​Node.js Example

​cURL Example

​Permissions and Roles

Role-Based Access

Custom Permissions

​Available Roles

​Custom Permissions

​Managing API Keys

​Security Best Practices

Storage & Handling

Access Control

Key Rotation

Monitoring

​Storage and Handling

​Access Control

​Key Rotation

​Additional Security Measures

​Monitoring and Logging

Usage Tracking

Audit Logs

Alerts

​Access Audit Logs

​Configure Alerts

​Troubleshooting

​Testing API Keys

​API Reference

Create API Key

List API Keys

Update API Key

Delete API Key

​Endpoints Summary

​Migration Guide

​From Username/Password

​From External Systems

​FAQ

​Support

Documentation

Support Portal

API Status

Community

API Keys

What are API Keys?

Key Benefits

Getting Started

Prerequisites

Creating an API Key

Via Dashboard

Via API

API Key Types

Personal API Keys

Team API Keys

Service API Keys

Authentication

Bearer Token Authentication

URL Parameter

Integration Examples

Environment Setup

Python Example

Node.js Example

cURL Example

Permissions and Roles

Available Roles

Custom Permissions

Managing API Keys

Security Best Practices

Storage and Handling

Access Control

Key Rotation

Additional Security Measures

Monitoring and Logging

Access Audit Logs

Configure Alerts

Troubleshooting

Testing API Keys

API Reference

Endpoints Summary

Migration Guide

From Username/Password

From External Systems

FAQ

Support