Recording pending: Add and review knowledge documents. Follow the written guide below.
Choose a source
You need access to the workspace, permission to manage knowledge documents, and an existing target agent if you intend to attach the source. This procedure uses the API operations linked below; the dashboard can also be used to inspect workspace resources.
Keep credentials, private customer records, and information outside the agent’s approved scope out of general-purpose knowledge documents. Give each source a clear name and an owner responsible for keeping it accurate.
Add and inspect
1
Prepare reviewed content
Remove outdated instructions, repeated navigation, and irrelevant sections. Use descriptive headings and explicit facts that a reader can understand without the surrounding website layout.
2
Create the document
Add the source through the dashboard or the corresponding API operation. Keep the returned document identifier and organize related sources in folders.
3
Read metadata and content back
Inspect document metadata and document content. Check that the stored representation contains the intended information.A successful create response alone does not prove that parsing, indexing, or retrieval has completed. Inspect the relevant status and content before attaching the source.
4
Review the agent attachment
Select the intended document in the agent configuration. Knowledge locators use
type, name, id, and usage_mode; the usage mode is auto or prompt.Review the attachment with the agent’s instructions and save a complete server draft on the intended branch. Check the stored references. Voice and custom-model publication are unavailable; only an eligible managed text-only configuration can use the current publication workflow.Attach knowledge to an existing agent after creation. The current create-agent path rejects a nonempty knowledge attachment list in the initial request.
Screenshot pending: A synthetic knowledge document with its stored content and processing status.
Storage and retrieval
Stored source content, processed document chunks, and retrieval during a live conversation are different stages. The API reference includes index and retrieval operations, but this guide does not claim that every ingestion or runtime retrieval path has been validated end to end.Document creation or a saved attachment does not establish that a live agent answered from that source. Check current availability and verify the ingestion and execution paths before relying on retrieval in an integration.
Update or remove a source
Check agents using the document before replacing or deleting it. The response is paginated: follownext_cursor while has_more is true, rather than relying only on the first page.
This dependency list covers active agent references and includes related nonarchived branches. It is not a complete inventory of references in historical versions. Review relevant branches and versions separately, since a change can affect more than the configuration currently open in the editor.
Use Replace file for a file source, Move an item to reorganize it, or Delete document or folder when it is no longer needed. Read the affected content and references back after the operation. Do not assume URL documents automatically synchronize with later website changes.
Troubleshooting
If content is empty or incomplete, inspect the source and stored representation before attaching it. If a document is unavailable to an agent, check its workspace, identifier, and resource access. If a delete or replacement affects existing agents, review dependencies and the intended configuration versions first. Continue with agent configuration and versions and drafts.Frequently asked questions
Does a created document prove retrieval is ready?
Does a created document prove retrieval is ready?
No. Inspect stored content and processing status. A saved attachment is separate from ingestion completion and retrieval during a live conversation.
Can I attach knowledge in the initial agent creation request?
Can I attach knowledge in the initial agent creation request?
The documented create-agent path rejects a nonempty knowledge list. Attach the source to an existing agent and read its saved configuration back.
Is the first dependency page enough before deletion?
Is the first dependency page enough before deletion?
No. Follow the returned cursor while has_more is true. Review relevant branches and historical versions separately because the dependency list is not a complete historical inventory.