Hybrid Search
The Search API is a hybrid search service that combines semantic understanding with keyword precision to deliver fast, contextual, and relevant results from your enterprise knowledge base. It enables secure, role-aware access to articles, FAQs, and documentation across customer, agent, and employee interfaces. Each query returns a ranked list of results with snippets, metadata, and relevance scores.
Authorization
accessToken JWT Bearer Token authentication for API access
In: header
Path Parameters
The ID of the portal being accessed.A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.
^[a-zA-Z0-9]{2,4}-\d{4,15}$7 <= length <= 20Query Parameters
The search query string. The string must be escaped as required by the URL syntax rules.
^[\w\W]+$1 <= length <= 1024The ID of the user profile.
^[a-zA-Z0-9]{2,4}-\d{4,15}$7 <= length <= 20The language that describes the details of a resource. Resources available in different languages may differ from each other. If lang is not passed, then the portal's default language is used.
Value in
- "en-US"
- "fr-FR"
- "en-GB"
- "es-ES"
- "it-IT"
- "nl-NL"
- "da-DA"
- "sv-SE"
- "pt-PT"
- "fi-FI"
- "no-NB"
- "no-NN"
- "ja-JA"
- "de-DE"
- "pt-BR"
- "zh-CN"
- "zh-TW"
- "ko-KO"
- "ru-RU"
- "el-EL"
- "tr-TR"
- "pl-PL"
- "cs-CS"
- "sk-SK"
- "hu-HU"
- "sr-SR"
- "ar-SA"
- "hr-HR"
- "ro-RO"
- "th-TH"
- "de-AT"
- "vi-VN"
- "id-ID"
- "ms-MY"
- "fil-PH"
- "fr-CA"
- "hi-IN"
- "uk-UA"
- "bg-BG"
- "sl-SI"
- "xx-XX"
An array of topic IDs. It is used to restrict search results to specific topics.
1 <= items <= 20One or more comma-separated names for article custom attributes defined by the user to be returned.
1 <= length <= 4000Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.
int641 <= value <= 11Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.
int641 <= value <= 3020Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/knowledge/portalmgr/v4/PROD-1000/search?q=What+is+a+loan%3F&%24lang=en-US&PROD-1234=PROD-2000%2CPROD-2003&PROD-2005=PROD-2007"{ "searchResults": { "article": [ { "id": "PROD-2731", "name": "What Does Loan Closing Mean?", "docType": "HTML", "source": "eGain Article", "snippet": "Closing, generally, is when you sign your <span class=\"hc\" style=\"background: #FFFF00\">loan</span> documents and become obligated on the mortgage <span class=\"hc\" style=\"background: #FFFF00\">loan</span>, and, in a purchase transaction, when the seller signs documents to transfer you title to the property. The timing may depend on state laws and local practices.", "keywordSnippet": "Closing, generally, is when you sign your <span class=\"hc\" style=\"background: #FFFF00\">loan</span> documents and become obligated on the mortgage <span class=\"hc\" style=\"background: #FFFF00\">loan</span>, and, in a purchase transaction, when the seller signs documents to transfer you title to the property. The timing may depend on state laws and local practices.", "additionalSnippets": [], "additionalSnippetCount": 0, "contextualSummary": "", "modifiedDate": "2022-10-20T15:11:33.000Z", "headerPath": "", "topicBreadcrumb": [ { "topicSummary": [ { "name": "Loans", "id": "PROD-1070" } ] } ], "tagCategories": [ { "id": "PROD-1014", "tags": [ "PROD-1022", "PROD-2196" ] } ], "articleTypeAttributes": { "typeName": "General", "articleTypeId": "100100000002020" }, "normalizedScore": 0.8953199783507835 }, { "id": "PROD-2680", "name": "What Information Will I Need to Apply for a Loan?", "docType": "HTML", "source": "eGain Article", "snippet": "Please have your personal information, annual income and any applicable collateral information available to apply.", "keywordSnippet": "Please have your personal information, annual income and any applicable collateral information available to apply.", "additionalSnippets": [], "additionalSnippetCount": 0, "contextualSummary": "", "modifiedDate": "2022-10-20T15:12:21.000Z", "headerPath": "", "topicBreadcrumb": [ { "topicSummary": [ { "name": "Loans", "id": "PROD-1070" } ] } ], "tagCategories": [ { "id": "PROD-1014", "tags": [ "PROD-2196", "PROD-1022" ] } ], "articleTypeAttributes": { "typeName": "General", "articleTypeId": "100100000002020" }, "normalizedScore": 0.8881018533023683 }, { "id": "PROD-2679", "name": "Can I have a Co-Signer?", "docType": "HTML", "source": "eGain Article", "snippet": "...Yes, A Co-Signer is <span class=\"hc\" style=\"background-color: #FFFF00\">someone who agrees to be responsible for someone else’s debt</span>. If you cosign someone’s loan and that person doesn’t make payments on the loan or defaults, you’ll have to repay the l...", "keywordSnippet": "", "additionalSnippets": [ { "id": "PROD-2679", "name": "Can I have a Co-Signer?", "docType": "HTML", "snippet": "...Yes, A Co-Signer is <span class=\"hc\" style=\"background-color: #FFFF00\">someone who agrees to be responsible for someone else’s debt</span>. If you cosign someone’s loan and that person doesn’t make payments on the loan or defaults, you’ll have to repay the l...", "keywordSnippet": "", "normalizedScore": 0.8472550848151883 }, { "id": "PROD-2679", "name": "Can I have a Co-Signer?", "docType": "HTML", "snippet": "...Yes, A Co-Signer is <span class=\"hc\" style=\"background-color: #FFFF00\">someone who agrees to be responsible for someone else’s debt</span>. If you cosign someone’s loan and that person doesn’t make payments on the loan or defaults, you’ll have to repay the l...", "keywordSnippet": "", "normalizedScore": 0.8472550848151883 } ], "additionalSnippetCount": 2, "contextualSummary": "", "modifiedDate": "2022-10-20T15:09:06.000Z", "headerPath": "", "topicBreadcrumb": [ { "topicSummary": [ { "name": "Loans", "id": "PROD-1070" } ] } ], "tagCategories": [ { "id": "PROD-1014", "tags": [ "PROD-2196", "PROD-1022" ] } ], "articleTypeAttributes": { "typeName": "General", "articleTypeId": "100100000002020" }, "normalizedScore": 0.8485992046672263 }, { "id": "PROD-2681", "name": "What is a Co-Signer? Requirements for a Co-Signer?", "docType": "HTML", "source": "eGain Article", "snippet": "...A co-signer is <span class=\"hc\" style=\"background-color: #FFFF00\">a person who is obligated to pay back the loan</span> just as you, the borrower, are obligated to pay.", "keywordSnippet": "", "additionalSnippets": [], "additionalSnippetCount": 0, "contextualSummary": "", "modifiedDate": "2022-12-08T21:15:56.000Z", "headerPath": "", "topicBreadcrumb": [ { "topicSummary": [ { "name": "Loans", "id": "PROD-1070" } ] } ], "tagCategories": [ { "id": "PROD-1014", "tags": [ "PROD-1022", "PROD-2196" ] } ], "articleTypeAttributes": { "typeName": "General", "articleTypeId": "100100000002020" }, "normalizedScore": 0.760438771174426 }, { "id": "PROD-2575", "name": "Glossary of Terms", "docType": "HTML", "source": "eGain Article", "snippet": "...Glossary of Terms A B C D E F G H I J K L M N O P Q R S T U V W X Y Z A Account A type of <span class=\"hc\" style=\"background-color: #FFFF00\">financial property or financial obligation that is held and owned under your name</span>. When you open a financial account—whether it’s a checking account, savings account, CD or money market accou...", "keywordSnippet": "", "additionalSnippets": [ { "id": "PROD-2575", "name": "Glossary of Terms", "docType": "HTML", "snippet": "...Glossary of Terms A B C D E F G H I J K L M N O P Q R S T U V W X Y Z A Account A type of <span class=\"hc\" style=\"background-color: #FFFF00\">financial property or financial obligation that is held and owned under your name</span>. When you open a financial account—whether it’s a checking account, savings account, CD or money market accou...", "keywordSnippet": "", "normalizedScore": 0.7319947071366003 }, { "id": "PROD-2575", "name": "Glossary of Terms", "docType": "HTML", "snippet": "...Glossary of Terms A B C D E F G H I J K L M N O P Q R S T U V W X Y Z A Account A type of <span class=\"hc\" style=\"background-color: #FFFF00\">financial property or financial obligation that is held and owned under your name</span>. When you open a financial account—whether it’s a checking account, savings account, CD or money market accou...", "keywordSnippet": "", "normalizedScore": 0.7312969754401869 }, { "id": "PROD-2575", "name": "Glossary of Terms", "docType": "HTML", "snippet": "...pay it back later. <span class=\"hc\" style=\"background-color: #FFFF00\">Deposit Funds added to your account. Direct deposit An automatic deposit to your account made by your employer or an outside agency (such as a pension or government benefit payment). These are usually recurring and spare you the hassle of depositing a paper check</span>. Online transfers ...", "keywordSnippet": "", "normalizedScore": 0.590190242899371 }, { "id": "PROD-2575", "name": "Glossary of Terms", "docType": "HTML", "snippet": "...e checks and make deposits into the same shared account. M Maturity date This is the date of expiration for the contractual obligation of a <span class=\"hc\" style=\"background-color: #FFFF00\">financial instrument</span>. For example, certificates of deposit have a maturity date that depends on the length of the CD term. When the CD matures, you have the opt...", "keywordSnippet": "", "normalizedScore": 0.5901298016434594 }, { "id": "PROD-2575", "name": "Glossary of Terms", "docType": "HTML", "snippet": "...e checks and make deposits into the same shared account. M Maturity date This is the date of expiration for the contractual obligation of a <span class=\"hc\" style=\"background-color: #FFFF00\">financial instrument</span>. For example, certificates of deposit have a maturity date that depends on the length of the CD term. When the CD matures, you have the opt...", "keywordSnippet": "", "normalizedScore": 0.5901298016434594 } ], "additionalSnippetCount": 5, "contextualSummary": "", "modifiedDate": "2022-10-20T15:04:42.000Z", "headerPath": "", "topicBreadcrumb": [ { "topicSummary": [ { "name": "Using Online Banking", "id": "PROD-1072" } ] } ], "tagCategories": [ { "id": "PROD-1014", "tags": [ "PROD-2196" ] } ], "articleTypeAttributes": { "typeName": "General", "articleTypeId": "100100000002020" }, "normalizedScore": 0.7319947071366003 }, { "id": "PROD-2732", "name": "What is The Amortization Period?", "docType": "HTML", "source": "eGain Article", "snippet": "...This is <span class=\"hc\" style=\"background-color: #FFFF00\">the repayment period</span> of a loan during which payments of both principal and interest are required to be made to pay down the balance on the loan according to the...", "keywordSnippet": "", "additionalSnippets": [ { "id": "PROD-2732", "name": "What is The Amortization Period?", "docType": "HTML", "snippet": "...This is <span class=\"hc\" style=\"background-color: #FFFF00\">the repayment period</span> of a loan during which payments of both principal and interest are required to be made to pay down the balance on the loan according to the...", "keywordSnippet": "", "normalizedScore": 0.6721146426033902 } ], "additionalSnippetCount": 1, "contextualSummary": "", "modifiedDate": "2022-10-20T15:13:19.000Z", "headerPath": "", "topicBreadcrumb": [ { "topicSummary": [ { "name": "Loans", "id": "PROD-1070" } ] } ], "tagCategories": [ { "id": "PROD-1014", "tags": [ "PROD-2196", "PROD-1022" ] } ], "articleTypeAttributes": { "typeName": "General", "articleTypeId": "100100000002020" }, "normalizedScore": 0.6721146426033902 }, { "id": "PROD-2615", "name": "Talk to a Banker - Home Loans", "docType": "HTML", "source": "eGain Article", "snippet": "Whether you have questions about buying or refinancing a home, applying for or paying off a mortgage or home equity line of credit, or how the home lending process works in general, we've got answers.\nMake an appointment with a [Sample Company Name] Bank today by visiting [Sample Website Address]...", "keywordSnippet": "Whether you have questions about buying or refinancing a home, applying for or paying off a mortgage or home equity line of credit, or how the home lending process works in general, we've got answers.\nMake an appointment with a [Sample Company Name] Bank today by visiting [Sample Website Address]...", "additionalSnippets": [], "additionalSnippetCount": 0, "contextualSummary": "", "modifiedDate": "2022-12-08T21:15:34.000Z", "headerPath": "", "topicBreadcrumb": [ { "topicSummary": [ { "name": "Loans", "id": "PROD-1070" } ] } ], "tagCategories": [ { "id": "PROD-1014", "tags": [ "PROD-1022" ] } ], "articleTypeAttributes": { "typeName": "General", "articleTypeId": "100100000002020" }, "normalizedScore": 0.45921719114211856 }, { "id": "PROD-2997", "name": "Discriminitatory Lending Practices", "docType": "HTML", "source": "eGain Article", "snippet": "<span class=\"hc\" style=\"background: #FFFF00\">What</span> are some of the warning signs of lending discrimination?\nThe signs of lending discrimination may be blatant or subtle. They can occur in the marketing of mortgage <span class=\"hc\" style=\"background: #FFFF00\">loan</span> products, mortgage <span class=\"hc\" style=\"background: #FFFF00\">loan</span> transactions, terms and conditions of the <span class=\"hc\" style=\"background: #FFFF00\">loan</span>, in the appraisal of a home, and in <span class=\"hc\" style=\"background: #FFFF00\">loan</span> servicing.", "keywordSnippet": "<span class=\"hc\" style=\"background: #FFFF00\">What</span> are some of the warning signs of lending discrimination?\nThe signs of lending discrimination may be blatant or subtle. They can occur in the marketing of mortgage <span class=\"hc\" style=\"background: #FFFF00\">loan</span> products, mortgage <span class=\"hc\" style=\"background: #FFFF00\">loan</span> transactions, terms and conditions of the <span class=\"hc\" style=\"background: #FFFF00\">loan</span>, in the appraisal of a home, and in <span class=\"hc\" style=\"background: #FFFF00\">loan</span> servicing.", "additionalSnippets": [], "additionalSnippetCount": 0, "contextualSummary": "", "modifiedDate": "2022-10-20T14:20:44.000Z", "headerPath": "", "topicBreadcrumb": [ { "topicSummary": [ { "name": "Banking Regulations", "id": "PROD-1080" } ] }, { "topicSummary": [ { "name": "Banking Regulations", "id": "PROD-1065" } ] } ], "tagCategories": [ { "id": "PROD-1014", "tags": [ "PROD-2930" ] } ], "articleTypeAttributes": { "typeName": "General", "articleTypeId": "100100000002020" }, "normalizedScore": 0.2830405804592237 }, { "id": "PROD-2733", "name": "What is the Difference Between Prequalification and Preapproval?", "docType": "HTML", "source": "eGain Article", "snippet": "Prequalification\nThe Banker collects estimates of your income and liabilities to determine <span class=\"hc\" style=\"background: #FFFF00\">what</span> mortgage products may be available to you and <span class=\"hc\" style=\"background: #FFFF00\">what</span> you can afford to borrow. Our Mortgage Bankers can prequalify you by phone, in some cases.", "keywordSnippet": "Prequalification\nThe Banker collects estimates of your income and liabilities to determine <span class=\"hc\" style=\"background: #FFFF00\">what</span> mortgage products may be available to you and <span class=\"hc\" style=\"background: #FFFF00\">what</span> you can afford to borrow. Our Mortgage Bankers can prequalify you by phone, in some cases.", "additionalSnippets": [], "additionalSnippetCount": 0, "contextualSummary": "", "modifiedDate": "2022-10-20T15:13:59.000Z", "headerPath": "", "topicBreadcrumb": [ { "topicSummary": [ { "name": "Loans", "id": "PROD-1070" } ] } ], "tagCategories": [ { "id": "PROD-1014", "tags": [ "PROD-1022", "PROD-2196" ] } ], "articleTypeAttributes": { "typeName": "General", "articleTypeId": "100100000002020" }, "normalizedScore": 0.18605361669534096 }, { "id": "PROD-2583", "name": "Using Zelle", "docType": "HTML", "source": "eGain Article", "snippet": "...lle you can send money to friends, family and almost anyone you know and trust, no matter where they bank in the U.S. Why Use Zelle It’s <span class=\"hc\" style=\"background-color: #FFFF00\">a fast and secure transfer</span> where money is deposited directly into your recipient’s bank account typically within minutes. You can also request money from others us...", "keywordSnippet": "", "additionalSnippets": [], "additionalSnippetCount": 0, "contextualSummary": "", "modifiedDate": "2022-10-25T14:07:19.000Z", "headerPath": "", "topicBreadcrumb": [ { "topicSummary": [ { "name": "Online Access", "id": "PROD-1001" }, { "name": "Zelle", "id": "PROD-1084" } ] }, { "topicSummary": [ { "name": "Using Online Banking", "id": "PROD-1072" }, { "name": "Zelle", "id": "PROD-1075" } ] } ], "tagCategories": [ { "id": "PROD-1014", "tags": [ "PROD-1756" ] } ], "articleTypeAttributes": { "typeName": "General", "articleTypeId": "100100000002020" }, "normalizedScore": 0.18394147762849983 }, { "id": "PROD-2554", "name": "Banking Regulations", "docType": "HTML", "source": "eGain Article", "snippet": "Some individual cities also enact their own financial regulation laws (for example, defining <span class=\"hc\" style=\"background: #FFFF00\">what</span> constitutes usurious lending).", "keywordSnippet": "Some individual cities also enact their own financial regulation laws (for example, defining <span class=\"hc\" style=\"background: #FFFF00\">what</span> constitutes usurious lending).", "additionalSnippets": [], "additionalSnippetCount": 0, "contextualSummary": "", "modifiedDate": "2022-10-20T14:17:48.000Z", "headerPath": "", "topicBreadcrumb": [ { "topicSummary": [ { "name": "Banking Regulations", "id": "PROD-1080" } ] }, { "topicSummary": [ { "name": "Banking Regulations", "id": "PROD-1065" } ] } ], "tagCategories": [ { "id": "PROD-1014", "tags": [ "PROD-2930" ] } ], "articleTypeAttributes": { "typeName": "General", "articleTypeId": "100100000002020" }, "normalizedScore": 0.16558712775547277 }, { "id": "PROD-2577", "name": "Short Description of Mobile Deposit", "docType": "HTML", "source": "eGain Article", "snippet": "Mobile check deposit allows you to save time by depositing your checks remotely, no matter where you are or <span class=\"hc\" style=\"background: #FFFF00\">what</span> time of day it is. Instead of making a run to the bank, you can simply snap a picture of the front and back of the check on your smartphone and deposit it using the bank's mobile app.", "keywordSnippet": "Mobile check deposit allows you to save time by depositing your checks remotely, no matter where you are or <span class=\"hc\" style=\"background: #FFFF00\">what</span> time of day it is. Instead of making a run to the bank, you can simply snap a picture of the front and back of the check on your smartphone and deposit it using the bank's mobile app.", "additionalSnippets": [], "additionalSnippetCount": 0, "contextualSummary": "", "modifiedDate": "2022-10-25T14:10:07.000Z", "headerPath": "", "topicBreadcrumb": [ { "topicSummary": [ { "name": "Checking and Savings Accounts", "id": "PROD-1066" } ] }, { "topicSummary": [ { "name": "Online Access", "id": "PROD-1001" }, { "name": "Mobile Banking", "id": "PROD-1082" } ] }, { "topicSummary": [ { "name": "Using Online Banking", "id": "PROD-1072" } ] } ], "tagCategories": [ { "id": "PROD-1014", "tags": [ "PROD-1020", "PROD-1756" ] } ], "articleTypeAttributes": { "typeName": "General", "articleTypeId": "100100000002020" }, "normalizedScore": 0.13648458089091964 }, { "id": "PROD-2568", "name": "Office of the Comptroller of the Currency (OCC) Banking Regulations", "docType": "HTML", "source": "eGain Article", "snippet": "OCC Bulletins\n\n\nOCC Comptroller’s Handbook\n\n\nPart 2 - Sales of Credit Life Insurance\n\n\nPart 14 - Consumer Protection in Sales of Insurance\n\n\nPart 21 - Minimum Security Devices and Procedures, SAR & BSA Compliance Program\n\n\nPart 22 - <span class=\"hc\" style=\"background: #FFFF00\">Loans</span> in Areas having Special Flood Hazards\n\n\nPart 25 - Community Reinvestment", "keywordSnippet": "OCC Bulletins\n\n\nOCC Comptroller’s Handbook\n\n\nPart 2 - Sales of Credit Life Insurance\n\n\nPart 14 - Consumer Protection in Sales of Insurance\n\n\nPart 21 - Minimum Security Devices and Procedures, SAR & BSA Compliance Program\n\n\nPart 22 - <span class=\"hc\" style=\"background: #FFFF00\">Loans</span> in Areas having Special Flood Hazards\n\n\nPart 25 - Community Reinvestment", "additionalSnippets": [], "additionalSnippetCount": 0, "contextualSummary": "", "modifiedDate": "2022-10-20T14:30:06.000Z", "headerPath": "", "topicBreadcrumb": [ { "topicSummary": [ { "name": "Banking Regulations", "id": "PROD-1080" } ] }, { "topicSummary": [ { "name": "Banking Regulations", "id": "PROD-1065" } ] } ], "tagCategories": [ { "id": "PROD-1014", "tags": [ "PROD-2930" ] } ], "articleTypeAttributes": { "typeName": "General", "articleTypeId": "100100000002020" }, "normalizedScore": 0.13457933361485352 }, { "id": "PROD-2766", "name": "How Do I Apply for a Credit Card?", "docType": "HTML", "source": "eGain Article", "snippet": "...ple Customer Service Phone Number] [Sample Credit Card Extension] / [Sample Text Based Phone Number], Mon–Fri 7 am–5 pm PT. To apply for the <span class=\"hc\" style=\"background-color: #FFFF00\">Secured Credit Card</span>, visit your local branch.", "keywordSnippet": "", "additionalSnippets": [], "additionalSnippetCount": 0, "contextualSummary": "", "modifiedDate": "2022-10-20T14:49:19.000Z", "headerPath": "", "topicBreadcrumb": [ { "topicSummary": [ { "name": "Checking and Savings Accounts", "id": "PROD-1066" }, { "name": "Credit Cards", "id": "PROD-1068" } ] } ], "tagCategories": [ { "id": "PROD-1014", "tags": [ "PROD-1024", "PROD-2048", "PROD-2196" ] } ], "articleTypeAttributes": { "typeName": "General", "articleTypeId": "100100000002020" }, "normalizedScore": 0.1103068233378137 } ] }}Get Tag Categories for Interest for a Portal GET
## Overview The Get Tag Categories for Interest for a Portal API retrieves the Tag Categories for Interest configured for a portal. * Tag Categories are ordered in order of their addition in the "Tag Categories for Interest" in the Portal configuration. * Tags are ordered as per their order defined in their Tag Category. * Tag Groups are sorted by their name, in ascending order.
Get Suggestion by Status GET
## Overview The Get Suggestion by Status API allows authenticated users to retrieve their own suggestions based on Suggestion status. ## Prerequisites * Enable the setting "My Suggestions" for the portal specified in the URL. * If the user is a customer, enable the setting "Allow Customer Access" for the portal.

