Arcanna AI
Introduction
This guide tells you how to authenticate the Arcanna AI connector in Swimlane using API Key Authentication. You will generate an API key in the Arcanna.ai platform, collect the required values, and configure the connector in Swimlane Turbine.
Prerequisites
Arcanna.ai Access Requirements
You must have administrative or API management access in Arcanna.ai to:
- Generate or manage API keys
- Access event ingestion and job management APIs
- View tenant-specific API endpoint information
Required Credentials
During setup, you will collect:
- Arcanna.ai API Base URL
- API Key
Authentication Method Overview
The Arcanna AI connector supports the following authentication method: API Key Authentication (Header-based using x-arcanna-api-key)
Arcanna.ai API Setup
Take the following steps to generate an API Key in Arcanna.ai:
- Log in to the Arcanna.ai platform with an administrator account.
- Navigate to the Settings or API Management section.
- Locate the API Keys section.
- Click Generate API Key or Create New Key.
- Provide a name/description for the key (if prompted).
- Generate the API key.
- Copy and securely store the generated API key. This value will not be displayed again.
Connector Configuration in Swimlane
Take the following steps to configure the Arcanna AI connector asset in Swimlane:
- Log in to Turbine.
- From the left-hand navigation pane, click ORCHESTRATION and click Assets.
- The Asset homepage opens.
- Click the plus icon to open the Configure your Connector Asset window.
- Select Arcanna AI from the Asset type list.
- Fill in the Asset Settings and Asset Input as shown below.
- Click Create.
Field | Description | Required |
|---|---|---|
url | Arcanna.ai API endpoint URL | Required |
x-arcanna-api-key | API key generated in Arcanna.ai | Required |
verify_ssl | Enable or disable SSL certificate verification | Optional |
http_proxy | Proxy configuration | Optional |
Troubleshooting
If authentication fails:
- Ensure the API key is active and correctly copied.
- Verify the API Base URL matches your Arcanna.ai tenant environment.
- Confirm the x-arcanna-api-key header is properly configured in the asset.
- Check SSL verification settings if using internal or self-signed certificates.
- Validate proxy configuration if traffic is routed through a proxy.
Sources
- Official Arcanna.ai API Documentation (Authentication & API Key Management)
Result
You have successfully authenticated the Arcanna AI connector in Swimlane using API Key Authentication.