The Knowledge Base APIs provide a suite of tools for managing documents, tables, and tags within your Voiceflow Knowledge Base. These APIs enable users to upload, retrieve, query, and manage data effectively, ensuring that the Knowledge Base remains organized, searchable, and responsive. Below is an overview of the key APIs available:
1. Query API
The Query API allows users to perform searches within the Voiceflow Knowledge Base to retrieve precise answers to questions. This API supports advanced filtering options, enabling users to narrow down their searches to find the most relevant data.
- Endpoint:
/knowledge-base/query - Base URL:
https://general-runtime.voiceflow.com - Method: POST
- Features:
- Allows users to submit queries and retrieve the most relevant chunks of information.
- Supports advanced query filtering capabilities, including equality and comparison, array operations, and logical operators.
- Enables users to control the synthesis of responses, model selection, temperature settings, and filtering using metadata or tags.
- Provides practical examples and guidelines for forming complex queries to meet specific search requirements.
2. Document API
The Document API offers extensive capabilities for managing various document types within the Knowledge Base. It supports uploading, replacing, deleting, and retrieving documents, including both unstructured and structured data such as tables.
- Endpoints:
/v3alpha/knowledge-base/docs/upload(POST) - Uploads a new document (excluding type "url")./v3alpha/knowledge-base/docs/{documentID}(GET, DELETE) - Retrieves or deletes a document by its ID./v3alpha/knowledge-base/docs/{documentID}/upload(PUT) - Replaces an existing document by its ID./v3alpha/knowledge-base/docs/upload(POST) - Uploads a document of type "url".- Tabular Data Support:
/v1/knowledge-base/docs/upload/table(POST) - Uploads new table data to the Knowledge Base. This endpoint supports fully customizable fields, including various data types such as string, number, array, or object.
- Base URL:
https://api.voiceflow.com - Features:
- Supports multiple document types, including URLs, PDFs, text files, DOCX files, and tabular data.
- Allows for attaching tags to documents for better organization and retrieval.
- Enables flexible management of documents with options for pagination, filtering, and handling documents in bulk.
- Provides robust support for tabular data, allowing users to upload structured datasets with searchable and metadata fields for enhanced query capabilities.
3. Tags API
The Tags API is designed for managing tags that are associated with Knowledge Base documents. Tags help categorize and filter documents, improving the accuracy and relevance of query responses.
- Endpoints:
/v3alpha/knowledge-base/tags(POST, GET) - Creates a new tag or retrieves a list of all tags./v3alpha/knowledge-base/tags/{tagID}(GET, DELETE, PATCH) - Manages a specific tag by its ID (retrieve, update, or delete)./v3alpha/knowledge-base/docs/{documentID}/tags/attach(POST) - Attaches tags to a specific document./v3alpha/knowledge-base/docs/{documentID}/tags/detach(POST) - Detaches tags from a specific document.
- Base URL:
https://api.voiceflow.com - Features:
- Facilitates dynamic tagging of documents for enhanced categorization and retrieval.
- Supports attaching and detaching tags to and from documents for flexible management.
- Allows for the retrieval and updating of tag labels, providing greater control over document categorization.
Authentication
All requests to the Knowledge Base APIs must be authenticated using a Dialog Manager API Key. The API Key can be obtained from the Integration tab in the Voiceflow project settings.