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.post265

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.post265
File	Size	Uploaded
nucliadb_agentic_api-1.0.0.post265.tar.gz	42.4 kB	Sep 2, 2026	Details

Built distribution (wheel)

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

Total release size: 93.4 kB

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

Download URL	nucliadb_agentic_api-1.0.0.post265.tar.gz
Size	42.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`631024ec39251a792a6d047440fa3c16e19e39da3416d08bec9114948d123ac3`
BLAKE2b-256 checksum How to use checksums	`3e2796810e323e22e2f7b96eb7398d19cef05864802d8a92ae731cac595b52b4`
Upload date	Sep 2, 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/0cba9f32e68c7dc877034e08bfa7a92917976b9d

Workflow

Publishing configuration: github.com/nuclia/nucliadb_agentic_api/blob/0cba9f32e68c7dc877034e08bfa7a92917976b9d/.github/workflows/nucliadb_agentic_api_workflow.yaml
Publishing logs: github.com/nuclia/nucliadb_agentic_api/actions/runs/33607745597/attempts/1

Artifact

Subject: nucliadb_agentic_api-1.0.0.post265.tar.gz
SHA-256 checksum: 631024ec39251a792a6d047440fa3c16e19e39da3416d08bec9114948d123ac3 Verifying attestations

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

Download URL	nucliadb_agentic_api-1.0.0.post265-py3-none-any.whl
Size	51.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`c68fab4000c1f1753cd94d8b641cec845013ed74994b7740b3576b8dacbc18eb`
BLAKE2b-256 checksum How to use checksums	`28361ac6e23575539a8c6a7d970ec45cc5f14db01f70be6fcab41dd7c70ad198`
Upload date	Sep 2, 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/0cba9f32e68c7dc877034e08bfa7a92917976b9d

Workflow

Publishing configuration: github.com/nuclia/nucliadb_agentic_api/blob/0cba9f32e68c7dc877034e08bfa7a92917976b9d/.github/workflows/nucliadb_agentic_api_workflow.yaml
Publishing logs: github.com/nuclia/nucliadb_agentic_api/actions/runs/33607745597/attempts/1

Artifact

Subject: nucliadb_agentic_api-1.0.0.post265-py3-none-any.whl
SHA-256 checksum: c68fab4000c1f1753cd94d8b641cec845013ed74994b7740b3576b8dacbc18eb Verifying attestations