Skip to main content
Home > “Admin Menu” > “API Keys”

​
API Keys

API keys enable direct access to assistants via the API to implement integrations into third-party applications such as chatbots, helpdesk systems, or web portals. This allows the assistants configured in VARIOS AI to be seamlessly integrated into existing workflows.
Info: The VARIOS AI API is OpenAI compatible.
Note: Each API key requires its own license. Make sure that sufficient licenses are available for the planned integrations.

​
Features at a glance

  • List view: Displays all existing API keys with names. Each key can be edited or deleted.
  • Search: Enables quick retrieval of individual keys.
  • New API Key: Use the “New API Key” button to create an additional key.

​
Create API key

When creating a new API key, the following options are available:
  1. Name
    Freely chosen label to identify the API key, e.g., Shopware Integration.
  2. Maximum costs per month ($)
    • Limit the monthly costs for this key.
    • Value 0 means that no costs are allowed.
    • Value -1 means no limit.
Note Projection based on tokens and may differ from actual billing costs.
  1. Assistants of the API key
    Select which assistants can be used with this key. Only shared assistants can be accessed by the connected application.

​
Typical use cases

  • Web chatbots with access to internal knowledge bases
  • Integration into CRM or ERP systems for automated processing of customer inquiries
  • Customer support portals that provide assistants for FAQs or self-service

​
Calling the Chat Completions API

Assistants can be accessed via the OpenAI-compatible endpoint /api/v1/chat/completions. Replace the base URL with your VARIOS AI instance address (e.g. https://varios-ai.example.com). Authentication: Pass the API key in the Authorization header as a Bearer token. Model parameter: The value for model is the assistant ID of the assistant you want to call. Only assistants assigned to the API key can be used. Optional parameters:
  • stream: true for streaming responses, false for a complete response in a single reply.
  • dlp_active: true enables Data Loss Prevention checks for the request, false disables them.
curl -X POST 'https://example.com/api/v1/chat/completions' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -d '{
    "model": "ASSISTANT_ID",
    "stream": false,
    "dlp_active": false,
    "messages": [
      {
        "content": "Why is the sky blue?",
        "role": "user"
      }
    ]
  }'

​
Management

  • Edit: Adjust name, cost limit, and assigned assistants.
  • Delete: Permanently removes the API key (access is immediately revoked).