{"id":45619,"library":"nucliadb-sdk","title":"NucliaDB SDK","description":"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).","status":"active","version":"6.14.0.post6509","language":"python","source_language":"en","source_url":"https://github.com/nuclia/nucliadb","tags":["nucliadb","sdk","unstructured-data","search","indexing"],"install":[{"cmd":"pip install nucliadb-sdk","lang":"bash","label":"Install latest stable"}],"dependencies":[{"reason":"Async HTTP client","package":"aiohttp","optional":false},{"reason":"Data validation","package":"pydantic","optional":false},{"reason":"gRPC communication","package":"grpcio","optional":false}],"imports":[{"note":"Module name is nucliadb_sdk, not nucliadb.","wrong":"from nucliadb import NucliaDB","symbol":"NucliaDB","correct":"from nucliadb_sdk import NucliaDB"},{"note":"Direct import of client class requires full path.","wrong":"from nucliadb import client","symbol":"NucliaDBClient","correct":"from nucliadb_sdk.client import NucliaDBClient"}],"quickstart":{"code":"import os\nfrom nucliadb_sdk import NucliaDB\n\n# Initialize the SDK\nndb = NucliaDB(\n    region=os.environ.get('NUCLIADB_REGION', 'europe-1'),\n    api_key=os.environ.get('NUCLIADB_API_KEY', ''),\n)\n\n# Create a knowledge box\nbox = ndb.create_knowledge_box(slug='my-box')\nprint(box)\n\n# Upload a text resource\nresource = ndb.upload_resource(\n    kb_id=box.uuid,\n    texts={'en': {'body': 'Hello world'}},\n)\nprint(resource.uuid)","lang":"python","description":"Initializes a NucliaDB client, creates a knowledge box, and uploads a simple text resource."},"warnings":[{"fix":"Use 'create_knowledge_box()' instead of 'knowledge_box()'.","message":"The 'knowledge_box' method was renamed to 'create_knowledge_box' and the old method is removed in v6.","severity":"breaking","affected_versions":">=6.0.0"},{"fix":"Pass the API key via the 'api_key' parameter or the 'NUCLIADB_API_KEY' environment variable.","message":"API key must be passed as 'api_key' argument, not 'api' or 'key'.","severity":"gotcha","affected_versions":"all"},{"fix":"Replace 'query' with 'query_text' in search calls.","message":"The 'search' method's 'query' parameter was deprecated in favor of 'query_text'.","severity":"deprecated","affected_versions":">=5.10.0"}],"env_vars":null,"search_vec":"'3.10':38 '4.0':40 '6.14.0':34 'box':30 'client':23 'cloud':11 'cloud-nat':10 'current':31 'data':16,51 'databas':13 'fix':46 'frequent':43 'high':21 'high-level':20 'index':25,53 'knowledg':29 'level':22 'manag':28 'nativ':12 'nucliadb':1,8,47 'offici':4 'post':45 'post-fix':44 'post6509':35 'provid':18 'python':5,37 'releas':41 'requir':36 'sdk':2,6,48 'search':26,52 'unstructur':15,50 'unstructured-data':49 'version':32","created_at":"2026-06-07T12:55:53.916096+00:00","updated_at":"2026-06-07T12:55:53.916096+00:00","problems":[{"fix":"Install nucliadb-sdk and import from nucliadb_sdk: 'from nucliadb_sdk import NucliaDB'.","cause":"Importing from the wrong module name.","error":"ModuleNotFoundError: No module named 'nucliadb'"},{"fix":"Set the NUCLIADB_API_KEY environment variable or pass 'api_key' argument correctly.","cause":"Missing or incorrect API key.","error":"nucliadb_sdk.exceptions.AuthenticationError: Invalid API key"},{"fix":"Ensure you are using nucliadb-sdk >=6.0 and pass 'slug' as a positional argument or check docs.","cause":"Deprecated parameter or wrong signature in older SDK version.","error":"TypeError: create_knowledge_box() got an unexpected keyword argument 'slug'"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":null,"cli_version":null,"type":"library","homepage":"https://github.com/nuclia/nucliadb","github":"https://github.com/nuclia/nucliadb","docs":null,"changelog":null,"pypi":null,"npm":null,"openapi_spec":null,"status_page":null,"smithery":null,"categories":["database","ai-ml"],"base_url":null,"auth_type":null,"provenance":{"verified_status":"passing","verified_at":"2026-06-29","last_verified":"2026-06-29","next_check":"2026-07-29","install_tag":null}}