NucliaDB Agentic API

The NucliaDB Agentic API package exposes NucliaDB-oriented agentic capabilities for Hyperforge, including ASK/search flows and MCP integrations.

Install

From the workspace root:

uv sync

Run

Start the service:

uv run nucliadb-agentic-api

Useful endpoints:

/health/ready
/health/alive
/metrics

Configuration

Runtime configuration is provided through environment variables consumed by Pydantic settings. Common settings include:

HTTP_HOST and HTTP_PORT
MEMORY_READER_NUCLIADB, MEMORY_WRITER_NUCLIADB, and MEMORY_SEARCH_NUCLIADB
MEMORY_APIKEY_NUCLIADB
VALKEY_URL
IDP_REGIONAL_GRPC
LOAD_MODULES

Development

Run the package tests from the workspace root:

make test

Objective

Enhance the RAG experience by offering RAO features directly in a KB.

How?

The same way we store search configs in the KB, we could store agentic configs, and when calling the /ask endpoint we can refer to a given agentic config.

Scope

The corresponding RAO workflow will be:

a Rephrase (optionally)
a SmartAgent
a Summarize

Possible sources for the SmartAgent:

The current KB (possibly several times with different filters)
Sync service (using connections defined in the current KB)
Google
Perplexity
MCP

Out of scope

Other KBs
SQL
Snowflake (?)
Sitefinity (?)

Config spec

{
  "rephrase": { // optional
    "ask_to": <filter_expression>, //optional
    "prompt": <string>, // optional
    "model": <model>, // optional
  },
  "smart_agent": {
    "mode": <reactive | plan_execute>,
    "extra_prompt": <string>, // optional
    "models": { // optional
      "context_validation": <model>, // optional
      "planner": <model>, // optional
      "executor": <model>, // optional
    },
    "sources": [<source list>]
  },
  "summarize": { // optional
    "user_prompt": <string>, // optional
    "system_prompt": <string>, // optional
    "conversational": <boolean>,
    "model": <model>, // optional
    // and citations must be forced to chunk-level
  }
}

And sources can be:

{
  "type": "nucliadb",
  "description": <string>,
  "search_config": <ask search configuration id>, // optional
  "filter_expression": <filter_expression>, //optional
}

{
  "type": "sync",
  "description": <string>,
  "connection": <connection_id>
}

{
  "type": "google",
  "description": <string>
}

{
  "type": "perplexity",
  "description": <string>
}

{
  "type": "mcp",
  "description": <string>,
  <...the MCP driver params>
}

Metadata

Release files for nucliadb-agentic-api 1.0.0.post292

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nucliadb-agentic-api 1.0.0.post292
File	Size	Uploaded
nucliadb_agentic_api-1.0.0.post292.tar.gz	43.5 kB	Sep 30, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for nucliadb-agentic-api 1.0.0.post292
File	Interpreter	ABI	Platform	Reset
nucliadb_agentic_api-1.0.0.post292-py3-none-any.whl 52.2 kB Sep 30, 2026	Python 3	none	any	Details

Total release size: 95.7 kB

Release files / nucliadb_agentic_api-1.0.0.post292.tar.gz

Download URL	nucliadb_agentic_api-1.0.0.post292.tar.gz
Size	43.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`df615b418a92526578455e112dac702fdfc1e0cb2c1446c786ecb2c329f5cc0f`
BLAKE2b-256 checksum How to use checksums	`29cbc8c8aab8413553236ded00025dea090972938fde8315a3e5892f9cc3d924`
Upload date	Sep 30, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.13.13`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/nuclia/nucliadb_agentic_api
Publishing commit: github.com/nuclia/nucliadb_agentic_api/tree/23e790282bd067a7e975562218bdffbbb459ba8f

Workflow

Publishing configuration: github.com/nuclia/nucliadb_agentic_api/blob/23e790282bd067a7e975562218bdffbbb459ba8f/.github/workflows/nucliadb_agentic_api_workflow.yaml
Publishing logs: github.com/nuclia/nucliadb_agentic_api/actions/runs/36678058735/attempts/1

Artifact

Subject: nucliadb_agentic_api-1.0.0.post292.tar.gz
SHA-256 checksum: df615b418a92526578455e112dac702fdfc1e0cb2c1446c786ecb2c329f5cc0f Verifying attestations

Release files / nucliadb_agentic_api-1.0.0.post292-py3-none-any.whl

Download URL	nucliadb_agentic_api-1.0.0.post292-py3-none-any.whl
Size	52.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`2d69a9ee383261f35909d47b3d5579df982c587d4ae67c545b2d6a5a832723ab`
BLAKE2b-256 checksum How to use checksums	`530a0424116f56377d7fb41ed4b1e45406a32d5148f59483423a97ada3f079ba`
Upload date	Sep 30, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.13.13`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/nuclia/nucliadb_agentic_api
Publishing commit: github.com/nuclia/nucliadb_agentic_api/tree/23e790282bd067a7e975562218bdffbbb459ba8f

Workflow

Publishing configuration: github.com/nuclia/nucliadb_agentic_api/blob/23e790282bd067a7e975562218bdffbbb459ba8f/.github/workflows/nucliadb_agentic_api_workflow.yaml
Publishing logs: github.com/nuclia/nucliadb_agentic_api/actions/runs/36678058735/attempts/1

Artifact

Subject: nucliadb_agentic_api-1.0.0.post292-py3-none-any.whl
SHA-256 checksum: 2d69a9ee383261f35909d47b3d5579df982c587d4ae67c545b2d6a5a832723ab Verifying attestations