---
id: nucliadb-protos
version: "7.1.0.post7000"
license: Apache-2.0
license_treatment: permissive
maintenance: active
---

# nucliadb-protos — Protobuf definitions for nucliadb

License: permissive · Maintenance: active · Downloads: 100.3K/mo

## What it is and what it does

nucliadb-protos is a package of Protocol Buffer message definitions for NucliaDB, a hybrid search database that indexes unstructured data using vector, full-text, and graph indexes. The package provides the serialized schema definitions needed to communicate with NucliaDB instances, whether self-hosted or via Nuclia Cloud. It serves as the contract layer between client code and the database, defining the structure of requests, responses, and data payloads.

This is a foundational dependency for any Python application that needs to interact with NucliaDB programmatically. Rather than a standalone tool, it is typically used as a transitive dependency of higher-level NucliaDB client libraries or as a direct import when building custom integrations. The package depends only on protobuf, keeping installation lightweight.

Use it for:

- Building a Python client library or wrapper around NucliaDB's API.
- Integrating NucliaDB search into a Python application that stores and queries unstructured data.
- Developing custom data pipelines that serialize and deserialize NucliaDB protocol messages.
- Contributing to or extending NucliaDB itself with new message types or API endpoints.

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

Provides Protocol Buffer message definitions for NucliaDB, enabling serialization and communication with the NucliaDB hybrid search database.

Yes, if you are building or using a Python application that communicates with NucliaDB. Install it as a dependency of a NucliaDB client library rather than directly unless you are working on NucliaDB integration or extension. The package is actively maintained, has no known vulnerabilities, and carries a permissive license.

## Install

pip install nucliadb-protos
uv add nucliadb-protos
poetry add nucliadb-protos

## Installing nucliadb-protos

Before you install: Low friction installation with a single runtime dependency on protobuf. Actively maintained with a release 3 days old and recent commits, suggesting stable ongoing development.

License in practice: Licensed under Apache-2.0 (permissive), allowing use, modification, and distribution with minimal restrictions—suitable for both open-source and commercial projects.

Quickstart:

pip install nucliadb-protos

from nucliadb_protos import <message_type>
# Use protobuf messages for NucliaDB communication

Requires Python 3.10 or later; protobuf must be installed as a runtime dependency.

Verify before relying:

- Specific protobuf message types and their use cases within NucliaDB client libraries or applications.
- Whether this package is intended for direct use or primarily as a transitive dependency of nucliadb or its clients.
- Performance or compatibility notes for different protobuf versions.

## Package facts

- License: Apache-2.0 (permissive)
- Python support: supports_current
- Install friction: low
- Maintenance: active
- Downloads: 100.3K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

protobuf definitions nucliadb, nucliadb protocol buffers, nucliadb client serialization, nucliadb message schemas, nucliadb api types, nucliadb grpc definitions, nucliadb data structures, protobuf, database-client, serialization

[View on SkillFed](https://skillfed.io/packages/nucliadb-protos) · [View on PyPI](https://pypi.org/project/nucliadb-protos/)