Artificial Intelligence Corporate Risk
  • Welcome
  • Getting Started
    • Inviting Users
    • Adding New Large Language Models
      • Azure OpenAI Service
      • OpenAI
      • Mistral
      • Google AI
      • LLaMA AI
      • AWS Bedrock
  • Chat
    • Initiating a Chat
    • Viewing Chat History
  • Dashboards
    • Creating Dashboards
    • Dashboard Elements
      • Top N
      • Charts and Graphs
      • Totals
      • Maps
  • Monitoring
    • Adding a User to the Monitor Role
    • Setting up alerts and issues
    • Editing Issues
  • Compliance
    • Adding a User to the Compliance Role
    • Creating a Search
    • Consuming the Results
  • Admin
    • AI Agents
      • Adding a New Agent
        • General Settings
        • Agent Engine Properties
          • Azure OpenAI
          • OpenAI
          • Mistral
          • Google AI
          • LLaMA AI
          • AWS Bedrock
        • Advanced Settings
          • Usage
            • Max Messages
            • LLM Temperature
          • Scanners
            • AI Scanners
            • General Scanners
          • API Keys
          • Files
      • Editing an Agent
      • Deleting an Agent
      • Adding from a Template
    • Company
      • General Information
      • External Agent Provider Settings
    • Custom APIs
      • OAuth2 API
      • Adding a New API
        • API Information
        • API Headers
        • API Endpoint Parameters
        • API Query Parameters
        • Body Parameters
      • Editing a Custom API
      • Deleting a Custom API
    • Custom Database
    • Users
      • Inviting a New User
      • Deleting a User
      • Roles
        • Accessing User Roles
      • Assigning an Agent
      • Setting a Default Agent
    • Groups
      • Adding a New Group
      • Deleting a Group
      • Assigning a User
      • Removing a User
      • Adding an Agent
      • Removing an Agent
    • Agent Scanner Defaults
      • Toxicity
      • Personal Information
      • Topic Scanner
      • Prompt Injection Detection
      • Regex Scanner
      • Geographic Gating
      • Language Detection
      • Allowed File Types
    • Logs
      • Interpreting Logs
  • Server Admin
    • Upgrade
    • Default Agents
      • Adding a New Agent
    • Data Archive
    • API Access
      • Chat
        • List Agents
        • Create Conversation
        • List of Conversations
        • Get Conversations
        • Ask Agent
        • Chat with Agent
        • Add File to Conversation
        • Add Files to Agent
        • Deleting a File
      • OAuth2
        • OAuth2
        • OAuth2 Token
      • Users
        • List Users
        • Create User
        • Add User to Group
        • Set User Token
        • Delete User
      • How to Launch Our API Example
        • How the Code Works
    • Configure OAuth2
    • Custom Secrets
  • API Overview
    • Authentication
    • Calling the Scanner
    • Consuming the Results
    • 📃Pagination
      • Understanding API Parameters
      • Pagination Helper
      • Example Page
      • Recap
    • AIRisk API OAuth2 Authentication
      • Authorization
      • Authorization Endpoint
        • Example Authorization URL
        • Error Responses
      • Tokens
        • Error Handling
        • Generic vs. User-Specific Tokens
          • Example Usage Flow / Reasons
        • Usage of the Access Token
      • Token Endpoint
        • Example Token Request
        • Error Responses
      • Summary of OAuth2 Authorization Flow
  • Managing Your Account
    • Personal Data
  • Support
    • Onboarding Check List
  • Internal Deployment
    • Outlook Plugin
    • Firewall Rules
    • Infrastructure
    • Graph Connection Requirements
    • Zoom Transcripts
  • Example Python Application
  • Release Notes
    • V4.28
    • V4.12
    • V4.0
    • V3.71
    • V3.0 Beta
    • V2.23
    • V2.22
    • V2.120 HotFix
    • V2.103 June 1
Powered by GitBook
On this page
  • AIR Key:
  • Agent Engine API Key:
  1. Admin
  2. AI Agents
  3. Adding a New Agent
  4. Advanced Settings

API Keys

Within the context of the agent configuration interface, API keys play a crucial role in facilitating secure communication and interaction between the agent and external systems or services.

PreviousGeneral ScannersNextFiles

Last updated 4 months ago

AIR Key:

The AIR Key serves as an authentication token specifically designed for accessing the AIR platform. This key is provided at sign-up and enables communication between agents and external agent engines. It allows licensed users to access the platform and leverage advanced natural language processing and generation algorithms for conversational interactions.

Agent Engine API Key:

The Agent Engine API Key is a unique authentication token associated with the agent engine instance deployed or utilized by the user. This key authenticates access to the specific agent engine, ensuring secure communication and integration with external applications, platforms, or services. It serves as a protective measure to restrict unauthorized access and safeguard sensitive data exchanged between the agent and external systems.

Security Considerations:

API keys are sensitive credentials that grant access to privileged resources and functionalities. As such, it's essential to handle them with care and adhere to best practices for security:

  1. Secure Storage: API keys should be stored securely, preferably in encrypted format, to prevent unauthorized access or theft.

  2. Restricted Access: Limit access to API keys only to authorized personnel or systems with a legitimate need for interaction.

  3. Rotation and Renewal: Regularly rotate API keys and revoke access for outdated or compromised keys to mitigate security risks.

  4. Audit Trails: Maintain audit trails to monitor API key usage and detect any suspicious or unauthorized activities.

By adhering to these security measures and best practices, users can ensure the integrity, confidentiality, and availability of their API keys, thereby enhancing the overall security posture of the agent and associated systems.