Enterprise context by Workato connector - Search documents

The Search documents action searches the knowledge base you specify by natural language or keyword search query.

The Search documents action runs a natural-language or keyword search across one or more knowledge bases and returns the matching documents. Use the filters to narrow results by content type, metadata, or date.

You can select multiple knowledge bases in a single call. Each selected knowledge base is queried as a separate request. The request volume counted against your rate limit increases when you select more knowledge bases.

Input

Input fieldDescription
Knowledge baseSelect the knowledge base you plan to search. Only recipe-type knowledge bases can be selected. Workato GO sources aren't supported. The handle appears in the URL.
QueryThe search query, as natural language or keywords.
PageThe page number to retrieve. Starts at 1. Defaults to 1.
Page sizeResults per page (1–100). Defaults to 50.
Content typeFilter by MIME type (stored in document metadata as mime_type).
Metadata filtersOptional key-value pairs stored with the document. For example, lang or source-system fields. Applied to all selected knowledge bases.
Created afterReturn only documents created after this date.
Created beforeReturn only documents created before this date.
Updated afterReturn only documents updated after this date.
Updated beforeReturn only documents updated before this date.

Output

Output fieldDescription
DocumentsThe list of documents that match the search.
Document IDThe ID of the document that contained the natural language search query or keyword you provided. For example: br689aec2ie03218te706l76y157nn12
TitleThe title of the document returned in the search.
Source URL (Documents)The source URL of the document.
Content typeThe content type of the document returned in the search. For example: application/vnd.openxmlformats-officedocument.presentationml.presentation
Owner emailThe email address of the user who owns each document returned in the search.
Created dateThe date each document returned in the search was created.
Updated dateThe date each document returned in the search was updated, if any.
Document contentThe content that matches the search query.
Metadata (Documents)The key-value metadata stored with the document.
Document type (Documents)The type of the returned item, for example document.
List size (Documents)The total number of documents returned on this page.
List index (Documents)The index of the current item in the documents list.
Total countThe total number of documents that match the search, across all pages.
Current pageThe page number of the returned results.

Last updated: