Connecting to Nuclia

Using API Key Authentication

Nuclia uses API key authentication for accessing Knowledge Box data. To obtain an API key:

1. Log in to the Nuclia Cloud Dashboard at https://nuclia.cloud
2. Navigate to your Knowledge Box settings
3. Go to the Service Accounts section
4. Create a new service account or copy an existing API key

After obtaining your API key, set the following connection properties:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Nuclia service account API key.
• KbId: Set this to your Knowledge Box UUID.
• Zone: Set this to your Nuclia deployment zone (e.g., aws-us-east-2-1).

Example Connection String

Profile=C:\profiles\Nuclia.apip;AuthScheme=APIKey;APIKey=your_service_account_key;KbId=your_kb_uuid;Zone=aws-us-east-2-1;

Connecting to Nuclia

Once the authentication is configured, you can connect to Nuclia and query data from any of the available tables such as Resources, KnowledgeBox, LabelSets, and ProcessingStatus.

Available Tables

The Nuclia API Profile provides access to the following tables:

• CustomSynonyms: Retrieve the custom synonyms map for the configured Nuclia Knowledge Box
• EntitiesGroupDetails: Retrieve a single Nuclia entity group by name (requires GroupName)
• EntitiesGroups: Retrieve all entity groups for the configured Nuclia Knowledge Box as a single aggregate row
• GenerativeModels: Retrieve the generative model providers and model catalog for the configured Nuclia Knowledge Box
• KbConfiguration: Retrieve the NLP model configuration for the configured Nuclia Knowledge Box
• KnowledgeBox: Retrieve configuration details for the configured Nuclia Knowledge Box
• KnowledgeBoxCounters: Retrieve storage and index statistics for the configured Nuclia Knowledge Box
• LabelSetDetails: Retrieve a single Nuclia label set by name (requires LabelSet)
• LabelSets: Retrieve all label sets for the configured Nuclia Knowledge Box as a single aggregate row
• ProcessingStatus: Retrieve the processing status queue for resources in the configured Nuclia Knowledge Box
• ResourceDetails: Retrieve full details for a single Nuclia Knowledge Box resource (requires Id)
• ResourceField: Retrieve a single field from a Nuclia Knowledge Box resource (requires ResourceId, FieldType, and FieldId)
• Resources: List all resources in the configured Nuclia Knowledge Box with pagination support

Important Notes

• All tables require APIKey, KbId, and Zone to be set as connection properties.
• Several tables require a filter to be specified in the query (e.g. ResourceDetails requires Id, ResourceField requires ResourceId, FieldType, and FieldId).
• The Resources table uses page-number based pagination; ProcessingStatus uses cursor-based pagination.
• Date fields use ISO 8601 format (yyyy-MM-dd'T'HH:mm:ssZ).
• Aggregate columns return JSON object or array values as strings.

API Documentation

For more information about the Nuclia API, see the official Nuclia API documentation at https://docs.nuclia.dev/docs/api.

Usage Examples

KnowledgeBox:

SELECT * FROM KnowledgeBox

KnowledgeBoxCounters:

SELECT * FROM KnowledgeBoxCounters

KbConfiguration:

SELECT * FROM KbConfiguration

Resources:

SELECT * FROM Resources

ResourceDetails:

SELECT * FROM ResourceDetails WHERE Id = 'resource-uuid'

ResourceField:

SELECT * FROM ResourceField WHERE ResourceId = 'resource-uuid' AND FieldType = 'file' AND FieldId = 'field-id'

ProcessingStatus:

SELECT * FROM ProcessingStatus

LabelSets:

SELECT * FROM LabelSets

LabelSetDetails:

SELECT * FROM LabelSetDetails WHERE LabelSet = 'my-labelset'

EntitiesGroups:

SELECT * FROM EntitiesGroups

EntitiesGroupDetails:

SELECT * FROM EntitiesGroupDetails WHERE GroupName = 'person'

CustomSynonyms:

SELECT * FROM CustomSynonyms

GenerativeModels:

SELECT * FROM GenerativeModels

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

---

Property	Description
APIKey	Your Nuclia NucliaDB service account API key.
AuthScheme	The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT
KbId	The UUID of your Nuclia Knowledge Box.
Zone	The Nuclia deployment zone identifier (e.g., europe-1, us-east-1).