Do I need the npm package?

No. If the npm package isn't available, search directly with fetch. See External integrations.

How do I authenticate?

With an API key in the x-api-key header. The key belongs on the server only. See Prerequisites.

Can I search straight from the browser?

Not with your API key: shipping it to the browser exposes it. Call the service from your own backend and hand the results to the frontend. See API keys.

Where do I get the Group ID?

From the Tuix dashboard: the Knowledge groups table shows the Group ID of every group, with a copy icon next to it. See Create a Knowledge Group.

Can I control whether search favours meaning or exact wording?

Not directly: the service combines both automatically and refines the order with a reranking step, there is nothing to configure per Knowledge Group. See Search and ranking.

How do I limit a search to certain content only?

Tag resources with a Role, then pass that same role in the search request. Resources left without a role are always included. See Role Filter.

A list of matching chunks under results, each with its text and a relevance score, sorted highest first. See Request reference.

Why did a search return no results, or a note?

Check the notes array in the response: it explains things like an empty Knowledge Group or a query that did not closely match anything. See Understanding results.

Can I connect this to an AI agent without writing any code?

Yes, through Tuix AI Agents: give it your Group ID and an API key, no integration code required.

Why do I get 403 Forbidden?

No x-api-key header was sent, or the key is unknown or was deleted. See API keys.

Why do I get 404 Not Found?

No Knowledge Group exists with the resourceGroupId you sent. Check it against the Knowledge groups table in the dashboard.

Basics

Getting Started Create a Knowledge Group Prerequisites API keys

Knowledge

Create Resources Search and ranking

Integrations

Tuix AI Agents External integrations

Reference

Request reference FAQ

FAQ

Common questions about the Tuix RAG Service.

FAQ