nucliadb-sdk

library6.14.0.post6509pypypi✓ verified 83d ago

The official Python SDK for NucliaDB, a cloud-native database for unstructured data. It provides a high-level client for indexing, searching, and managing knowledge boxes. Current version is 6.14.0.post6509, requiring Python >=3.10 and <4.0. Releases are frequent (post-fixed).

database ai-ml

pip install nucliadb-sdk

github ↗homepage ↗

INSTALL

IMPORT

SIG · NUCLIADB-SDK

nucliadb-sdk

databasepythonv6.14.0.post6509

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

NucliaDB

✓ from nucliadb_sdk import NucliaDB

✗ from nucliadb import NucliaDB

Module name is nucliadb_sdk, not nucliadb.

NucliaDBClient

✓ from nucliadb_sdk.client import NucliaDBClient

✗ from nucliadb import client

Direct import of client class requires full path.

Initializes a NucliaDB client, creates a knowledge box, and uploads a simple text resource.

import os from nucliadb_sdk import NucliaDB # Initialize the SDK ndb = NucliaDB( region=os.environ.get('NUCLIADB_REGION', 'europe-1'), api_key=os.environ.get('NUCLIADB_API_KEY', ''), ) # Create a knowledge box box = ndb.create_knowledge_box(slug='my-box') print(box) # Upload a text resource resource = ndb.upload_resource( kb_id=box.uuid, texts={'en': {'body': 'Hello world'}}, ) print(resource.uuid)

Debug

Known issues

breakingThe 'knowledge_box' method was renamed to 'create_knowledge_box' and the old method is removed in v6.

fix

Use 'create_knowledge_box()' instead of 'knowledge_box()'.

affects: >=6.0.0

gotchaAPI key must be passed as 'api_key' argument, not 'api' or 'key'.

fix

Pass the API key via the 'api_key' parameter or the 'NUCLIADB_API_KEY' environment variable.

affects: all

deprecatedThe 'search' method's 'query' parameter was deprecated in favor of 'query_text'.

fix

Replace 'query' with 'query_text' in search calls.

affects: >=5.10.0

Errors

Common errors & fixes

ModuleNotFoundError: No module named 'nucliadb'

Importing from the wrong module name.

fix

Install nucliadb-sdk and import from nucliadb_sdk: 'from nucliadb_sdk import NucliaDB'.

nucliadb_sdk.exceptions.AuthenticationError: Invalid API key

Missing or incorrect API key.

fix

Set the NUCLIADB_API_KEY environment variable or pass 'api_key' argument correctly.

TypeError: create_knowledge_box() got an unexpected keyword argument 'slug'

Deprecated parameter or wrong signature in older SDK version.

fix

Ensure you are using nucliadb-sdk >=6.0 and pass 'slug' as a positional argument or check docs.

Upgrade

Version history

6.14.0.post6509latest on PyPI · released Jun 5, 2026

Audit

Dependencies

aiohttprequiredAsync HTTP client

pydanticrequiredData validation

grpciorequiredgRPC communication

Agent activity

17 hits · last 30 days

node

Resources

githubhttps://github.com/nuclia/nucliadb ↗

homepagehttps://github.com/nuclia/nucliadb ↗