> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ringg.ai/llms.txt
> Use this file to discover all available pages before exploring further.
> ## Agent Instructions
> To search or read these docs, connect the Ringg docs MCP server at https://docs.ringg.ai/mcp (no key needed; tools search_ringg_ai and query_docs_filesystem_ringg_ai) instead of browsing pages one by one. Setup for each client: https://docs.ringg.ai/resources/mcp-server/docs-mcp-server/mcp-for-ai-assistants.md
> The dashboard labels agents "Assistants"; these docs say "agent". Both mean the same object, identified by agent_id.
> API base URL: https://prod-api.ringg.ai/ca/api/v0. Send the workspace API key in the X-API-KEY header, from server-side code only.
> Placing a call dials a real phone number and spends credits. Confirm the number with the user before calling.
> To act on a Ringg workspace (place calls, edit agents, read transcripts), use the separate Ringg workspace MCP server at https://mcp.ringg.ai/mcp: https://docs.ringg.ai/resources/mcp-server/workspace-mcp-server/overview.md
# Attach a knowledge base
> Attach or detach knowledge bases on a Ringg AI agent, mention them in the prompt with @, add query phrases, and test that the agent answers from your data.
An agent can have several knowledge bases, and one knowledge base can serve many agents.
In the dashboard: Agents (listed under **Assistants** in the sidebar) → open an agent → **Knowledge Base** in the editor sidebar.
## Before you start
Created in the same workspace, with status **Ready**.
The agent that will answer from it.
## Attach or detach a knowledge base
In the agent editor, click **Knowledge Base**, then **Select Knowledge Base**, and tick one or more. Each tick attaches it at once: "Knowledge base attached successfully". The button then shows the count.
Click the trash icon on an attached knowledge base, or untick it in the list: "Knowledge base detached successfully".
Attached knowledge bases are listed below the button and appear under **Knowledge Bases** when you type `@` in the [prompt](/documentation/build-agents/customize-agent-behaviour/agent-prompt).
**Add Knowledge Base** at the bottom of the list opens the Knowledge base page to create a new one ([Create a knowledge base](/documentation/inventory/knowledge-base#create-a-knowledge-base)). If the button reads **No knowledge bases found**, the workspace has none yet; create one there first.
You can also attach knowledge bases while you [create the agent](/documentation/build-agents/agents/create-an-agent).
Attachments belong to the version you are editing. On an agent with several [versions](/documentation/build-agents/test-and-improve/drafts-and-versions), attach the knowledge base to each version that needs it.
### Multi-prompt agents
A [multi-prompt agent](/documentation/build-agents/agents/multi-prompt-agents/overview) has knowledge bases at two levels:
| Where | Applies to |
| - | - |
| **Global settings → Knowledge base** ([Global Settings](/documentation/build-agents/agents/multi-prompt-agents/global-settings#global-settings)) | The whole agent |
| An **Agent** node's **Knowledge base** section ([node types](/documentation/build-agents/agents/multi-prompt-agents/node-types-and-connections#node-types)) | That node only |
Changes go into the draft, so [publish the agent](/documentation/build-agents/test-and-improve/drafts-and-versions#publish-changes-on-a-multi-prompt-agent) for callers to get them. Once a node has a knowledge base or an on-call tool, it also shows **Query Phrases**: "Phrases the assistant will say before querying a knowledge base or running an on-call tool on this node." Add short fillers such as "Let me check that for you." so the caller does not hear silence during the lookup.
## Mention it in the prompt
Type `@` in the prompt and pick the knowledge base from the **Knowledge Bases** group. Only attached knowledge bases are listed. A mention isn't required: the agent can search every attached knowledge base either way. The mention uses the knowledge base's name and tells the agent which knowledge base covers which questions. For a knowledge base named `loan_faqs`:
```text theme={null}
For questions about interest rates, eligibility or documents, answer from @loan_faqs.
If the answer is not there, say you will check and have an advisor call back.
```
See [Write the prompt](/documentation/build-agents/customize-agent-behaviour/agent-prompt) for how mentions work. If you detach a knowledge base that the prompt still mentions, the mention turns red; remove it or attach the knowledge base again.
## How the agent uses it in a call
During the conversation, the agent searches an attached knowledge base when it decides a question needs it, not on every turn, and answers from what it finds. For CSV columns marked **Exact match** ([column configuration](/documentation/inventory/knowledge-base#structured-data-and-column-configuration)), the lookup matches the exact value, such as an order ID the caller reads out.
## Do this with the API
Call [Edit Assistant](/api-reference/endpoint/assistant/edit-assistant) (`PATCH /agent/v1`) with `operation` set to `attach_kb` or `remove_kb` and the `kb_id`, once per knowledge base. Send your [API key](/documentation/manage-account/api-key) in `X-API-KEY`.
```bash cURL theme={null}
curl --request PATCH "https://prod-api.ringg.ai/ca/api/v0/agent/v1" \
--header "X-API-KEY: $RINGG_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"operation": "attach_kb",
"agent_id": "b1972188-038e-4605-916c-3926e9d7bde4",
"kb_id": "550e8400-e29b-41d4-a716-446655440000"
}'
```
Get the `kb_id` from [Get All Knowledge Bases](/api-reference/endpoint/kb/get-all-knowledge-bases), and the `agent_id` from the editor ([Find an agent's ID](/documentation/build-agents/agents/agent-types#find-the-agent-id)). To create knowledge bases by API, see [Create Knowledge Base](/api-reference/endpoint/kb/create-knowledge-base).
## Test it
Ask your questions in the knowledge base's test chat first ([Test it in chat](/documentation/inventory/knowledge-base#test-it-in-chat)). If the answer is wrong there, fix the data before you test the agent.
Place a test call or chat ([Test an agent](/documentation/build-agents/test-and-improve/test-an-agent)) and ask the same questions, phrased the way a customer would.
Open the call in [Logs](/documentation/monitor/logs#the-call-panel) and read the **Transcript** tab to see exactly what the agent answered.
The agent's answers match the knowledge base's test chat.
## Next steps
Connect the agent to your APIs before, during and after a call.
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.
See [Write the prompt](/documentation/build-agents/customize-agent-behaviour/agent-prompt) for how mentions work. If you detach a knowledge base that the prompt still mentions, the mention turns red; remove it or attach the knowledge base again.
## How the agent uses it in a call
During the conversation, the agent searches an attached knowledge base when it decides a question needs it, not on every turn, and answers from what it finds. For CSV columns marked **Exact match** ([column configuration](/documentation/inventory/knowledge-base#structured-data-and-column-configuration)), the lookup matches the exact value, such as an order ID the caller reads out.
## Do this with the API
Call [Edit Assistant](/api-reference/endpoint/assistant/edit-assistant) (`PATCH /agent/v1`) with `operation` set to `attach_kb` or `remove_kb` and the `kb_id`, once per knowledge base. Send your [API key](/documentation/manage-account/api-key) in `X-API-KEY`.
```bash cURL theme={null}
curl --request PATCH "https://prod-api.ringg.ai/ca/api/v0/agent/v1" \
--header "X-API-KEY: $RINGG_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"operation": "attach_kb",
"agent_id": "b1972188-038e-4605-916c-3926e9d7bde4",
"kb_id": "550e8400-e29b-41d4-a716-446655440000"
}'
```
Get the `kb_id` from [Get All Knowledge Bases](/api-reference/endpoint/kb/get-all-knowledge-bases), and the `agent_id` from the editor ([Find an agent's ID](/documentation/build-agents/agents/agent-types#find-the-agent-id)). To create knowledge bases by API, see [Create Knowledge Base](/api-reference/endpoint/kb/create-knowledge-base).
## Test it