{"info":{"_postman_id":"03fe9768-f867-473e-9b29-d0fdb11e002d","name":"TymBot","description":"<html><head></head><body><p>The TymBot collection contains set of REST endpoints that allow you to query a chatbot and manage it's knowledge base.</p>\n<p>Use this API to integrate Tym chatbots on your app.</p>\n<h2 id=\"getting-started-guide\"><strong>Getting started guide</strong></h2>\n<p>To start using the TymBot API, follow the below steps.</p>\n<ul>\n<li><p>You must use a valid API Key to send requests to the API endpoints. You can get your API key from <strong>Account &gt; API</strong> <strong>Keys</strong> page of the TymBot app.</p>\n</li>\n<li><p>Each API Key has an expiry of 12 months upon creation. Later which you need to create a new one.</p>\n</li>\n<li><p>The API returns request responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.</p>\n</li>\n</ul>\n<h2 id=\"authentication\">Authentication</h2>\n<p>The TymBot API uses Bearer Token for authentication.</p>\n<p>You must include an API key in each request to the API with the Authorization request header.</p>\n<p>Generate an API Key if not holding one here: <a href=\"https://dev-app.tymbot.io/account/api-keys\">https://app.tymbot.io/account/api-keys</a></p>\n<h3 id=\"authentication-error-response\">Authentication error response</h3>\n<p>If an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.</p>\n<h3 id=\"need-some-help\"><strong>Need some help?</strong></h3>\n<p>In case you have questions, go through our tutorials <a href=\"https://www.youtube.com/@apnatomyllc\">https://www.youtube.com/@apnatomyllc</a>. Or contact us at <a href=\"https://www.tymbot.io/contact.html\">https://www.tymbot.io/contact.html.</a></p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"37376001","collectionId":"03fe9768-f867-473e-9b29-d0fdb11e002d","publishedId":"2sA3kdAdH2","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2953e8"},"publishDate":"2024-08-01T10:07:01.000Z"},"item":[{"name":"Get Chatbot","id":"94058bd1-ad81-46fb-a087-1e16607b0485","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}","description":"<p>Get chatbot with given ID.</p>\n<p><strong>Path Parameters:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Param</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>projectId</td>\n<td>The ID of the project in which chatbot is created.</td>\n</tr>\n<tr>\n<td>chatbotId</td>\n<td>The ID of the chatbot.</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"bearer","bearer":{"token":"{apiKey}"},"isInherited":true,"source":{"_postman_id":"03fe9768-f867-473e-9b29-d0fdb11e002d","id":"03fe9768-f867-473e-9b29-d0fdb11e002d","name":"TymBot","type":"collection"}},"urlObject":{"path":["pub","projects","{projectId}","chatbots","{chatbotId}"],"host":["https://server.tymbot.io/api/v1"],"query":[],"variable":[]}},"response":[{"id":"d9897cd0-e9d5-4c8f-9bef-fdec16303589","name":"Get Chatbot","originalRequest":{"method":"GET","header":[],"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"396","enabled":true},{"key":"ETag","value":"W/\"18c-q9a0BVqzrca/4Q0m7bsSfdFy36o\"","enabled":true},{"key":"Date","value":"Thu, 01 Aug 2024 08:54:47 GMT","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Keep-Alive","value":"timeout=5","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"Chatbot fetched\",\n    \"data\": {\n        \"integration\": {\n            \"code\": \"43ef0ef7-9a09-4719-88ba-bc9f84cf749c\"\n        },\n        \"_id\": \"669fb9579e9fff0c05ddc025\",\n        \"name\": \"Real Estate Agent\",\n        \"liveId\": \"fd6f2fd6215a44afad71fbb3127d47f0\",\n        \"project\": {\n            \"_id\": \"65c5d3b289856a4582650894\",\n            \"name\": \"Star Realtors\",\n            \"description\": \"This is a real estate business dealing with residential properties.\"\n        },\n        \"status\": \"completed\",\n        \"isTemplate\": false\n    }\n}"}],"_postman_id":"94058bd1-ad81-46fb-a087-1e16607b0485"},{"name":"Query Chatbot","id":"a17799ea-571e-428c-9de0-8ba3072f273c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"message\": \"What can you help me with?\",\n    \"chatId\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}/query","description":"<p>Receive AI-generated responses by querying the chatbot trained on your knowledge base.</p>\n<p><strong>Path Parameters:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Param</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>projectId</td>\n<td>The ID of the project in which chatbot is created.</td>\n</tr>\n<tr>\n<td>chatbotId</td>\n<td>The ID of the chatbot.</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"bearer","bearer":{"token":"{apiKey}"},"isInherited":true,"source":{"_postman_id":"03fe9768-f867-473e-9b29-d0fdb11e002d","id":"03fe9768-f867-473e-9b29-d0fdb11e002d","name":"TymBot","type":"collection"}},"urlObject":{"path":["pub","projects","{projectId}","chatbots","{chatbotId}","query"],"host":["https://server.tymbot.io/api/v1"],"query":[],"variable":[]}},"response":[{"id":"1339efb9-636a-48e1-8bdb-bbb116d228cc","name":"Query Chatbot","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"message\": \"What can you help me with?\",\n    \"chatId\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}/query"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"208"},{"key":"ETag","value":"W/\"d0-0lfy5olhRG5NqSscezf1XKIfQWA\""},{"key":"Date","value":"Fri, 02 Aug 2024 06:41:19 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"Chatbot response generated\",\n    \"data\": {\n        \"isStream\": false,\n        \"response\": \"Hello! I'm TYM, your friendly assistant. How can I assist you today?\",\n        \"mediaFiles\": [],\n        \"chatId\": \"10a36bff15334f50adf9d3a3746dfd7b\"\n    }\n}"}],"_postman_id":"a17799ea-571e-428c-9de0-8ba3072f273c"},{"name":"List All Knowledge Base","id":"3ed811fd-1c55-4b16-94c7-584d044f7dde","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}/knowledge-base","description":"<p>List all knowledge base resources of a chatbot.</p>\n<p><strong>Path Parameters:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Param</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>projectId</td>\n<td>The ID of the project in which chatbot is created.</td>\n</tr>\n<tr>\n<td>chatbotId</td>\n<td>The ID of the chatbot.</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"bearer","bearer":{"token":"{apiKey}"},"isInherited":true,"source":{"_postman_id":"03fe9768-f867-473e-9b29-d0fdb11e002d","id":"03fe9768-f867-473e-9b29-d0fdb11e002d","name":"TymBot","type":"collection"}},"urlObject":{"path":["pub","projects","{projectId}","chatbots","{chatbotId}","knowledge-base"],"host":["https://server.tymbot.io/api/v1"],"query":[],"variable":[]}},"response":[{"id":"dee6f9f2-b84b-4c48-bd97-3bb9a2300652","name":"List All Knowledge Base","originalRequest":{"method":"GET","header":[],"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}/knowledge-base"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"6513","enabled":true},{"key":"ETag","value":"W/\"1971-E4P4EkRlRjyUo+zzw6pD4BKWsgU\"","enabled":true},{"key":"Date","value":"Thu, 01 Aug 2024 08:59:05 GMT","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Keep-Alive","value":"timeout=5","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"Knowledge Base of chatbot fetched\",\n    \"data\": [\n        {\n            \"_id\": \"66ab4e47cd6be7af3a76a33c\",\n            \"name\": \"About Company\",\n            \"description\": \"This document contains the agency offerings and expertise\",\n            \"resourceType\": \"document\",\n            \"resource\": {\n                \"originalFilenames\": [\n                    \"Star Realtors.docx\"\n                ]\n            },\n            \"extractedContent\": \"### Discover Your Dream Home with Our Premier Real Estate Agency At [Your Real Estate Agency Name], we understand that finding the perfect home is a journey filled with excitement, anticipation, and sometimes a bit of anxiety. That's why we're here to guide you every step of the way, offering unparalleled expertise, personalized service, and a deep commitment to helping you find a place you'll love to call home. #### Our Mission: Making Homeownership Dreams Come True Our mission is simple: to make the dream of homeownership a reality for our clients. Whether you're a first-time homebuyer, looking to upgrade to a larger space, or searching for the perfect investment property, we have the resources, knowledge, and passion to assist you. Our team of experienced real estate agents is dedicated to providing a seamless and stress-free experience, ensuring that every transaction is handled with the utmost care and professionalism. #### A Wide Range of Residential Properties We specialize in a wide range of residential properties, catering to diverse tastes and budgets. From cozy apartments in bustling city centers to spacious family homes in tranquil suburbs, we offer an extensive portfolio of listings to suit every lifestyle. Our properties include: 1. **Single-Family Homes**: Ideal for families, our single-family homes offer ample space, privacy, and a welcoming atmosphere. We have homes in various architectural styles and sizes, ensuring there's something for everyone. 2. **Condos and Townhouses**: For those who prefer a more urban lifestyle, our selection of condos and townhouses provides modern living with the convenience of low-maintenance ownership. Enjoy amenities such as gyms, pools, and concierge services, all within walking distance of vibrant city life. 3. **Luxury Estates**: If you're looking for the pinnacle of luxury living, our portfolio of high-end estates will impress even the most discerning buyers. These properties feature top-of-the-line finishes, expansive grounds, and breathtaking views. 4. **New Developments**: Stay ahead of the curve with our exclusive access to new developments. Whether you're interested in pre-construction opportunities or newly completed homes, we provide comprehensive information and support throughout the buying process. #### Why Choose Us? Choosing the right real estate agency is crucial to a successful property search. Here's why [Your Real Estate Agency Name] stands out: 1. **Expert Knowledge**: Our agents are seasoned professionals with extensive knowledge of the local real estate market. We stay up-to-date with market trends, property values, and neighborhood developments, providing you with accurate and timely information. 2. **Personalized Service**: We believe in building lasting relationships with our clients. Our agents take the time to understand your needs, preferences, and goals, offering tailored recommendations that align with your vision. 3. **Comprehensive Support**: From initial consultations to closing, we provide comprehensive support throughout the entire buying or selling process. Our services include property searches, market analysis, contract negotiation, and assistance with financing options. 4. **Cutting-Edge Technology**: We leverage the latest technology to enhance your property search experience. Our user-friendly website, virtual tours, and mobile app allow you to explore listings and stay informed from anywhere, at any time. 5. **Strong Network**: Over the years, we've built a strong network of industry professionals, including mortgage brokers, home inspectors, contractors, and attorneys. This network ensures you have access to the best resources and expertise when making important decisions. #### Client Testimonials: Real Stories, Real Satisfaction Don't just take our word for it-hear from our satisfied clients! We pride ourselves on the positive feedback we've received from countless homeowners who have trusted us with their real estate needs. Our testimonials reflect our commitment to excellence and the genuine care we offer each client. #### The Home Buying Process: What to Expect Buying a home can be a complex process, but with [Your Real Estate Agency Name] by your side, you'll have a clear and straightforward path to homeownership. Here's an overview of what to expect: 1. **Initial Consultation**: We'll start with a detailed consultation to understand your requirements, budget, and timeline. This helps us tailor our search to find the best properties that meet your criteria. 2. **Property Search and Viewing**: Using our advanced search tools, we'll curate a list of properties that match your preferences. We'll arrange viewings at your convenience, providing insightful guidance and answering any questions you may have. 3. **Making an Offer**: Once you've found the perfect property, we'll assist you in crafting a competitive offer. Our agents are skilled negotiators, working diligently to secure the best possible deal on your behalf. 4. **Due Diligence and Inspection**: We'll guide you through the due diligence process, including property inspections, appraisals, and reviewing necessary documents. This step ensures you have a complete understanding of the property's condition and value. 5. **Closing the Deal**: As the final step, we'll coordinate with all parties involved to ensure a smooth and timely closing. We'll review the closing documents with you and answer any final questions, ensuring you're fully informed before signing. 6. **Post-Purchase Support**: Our relationship doesn't end at closing. We offer ongoing support to help you settle into your new home and connect you with trusted service providers for any post-purchase needs. #### Ready to Find Your Dream Home? At Star Realtors, we believe that finding the perfect home should be a joyful and memorable experience. Our team is dedicated to helping you navigate the real estate market with confidence and ease. Whether you're buying, selling, or investing, we're here to support you every step of the way. Contact us today to start your journey toward finding the perfect home. Let's make your real estate dreams a reality!\",\n            \"fromTemplate\": false,\n            \"status\": \"extraction_completed\"\n        }\n    ]\n}"}],"_postman_id":"3ed811fd-1c55-4b16-94c7-584d044f7dde"},{"name":"Get Knowledge Base","id":"8a12fb0c-e004-46fa-8691-a49c7940c352","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}/knowledge-base/{knowledgeBaseId}","description":"<p>Get knowledge base with the given ID.</p>\n<p><strong>Path Parameters:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Param</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>projectId</td>\n<td>The ID of the project in which chatbot is created.</td>\n</tr>\n<tr>\n<td>chatbotId</td>\n<td>The ID of the chatbot.</td>\n</tr>\n<tr>\n<td>knowledgeBaseId</td>\n<td>The ID of the knowledge base.</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"bearer","bearer":{"token":"{apiKey}"},"isInherited":true,"source":{"_postman_id":"03fe9768-f867-473e-9b29-d0fdb11e002d","id":"03fe9768-f867-473e-9b29-d0fdb11e002d","name":"TymBot","type":"collection"}},"urlObject":{"path":["pub","projects","{projectId}","chatbots","{chatbotId}","knowledge-base","{knowledgeBaseId}"],"host":["https://server.tymbot.io/api/v1"],"query":[],"variable":[]}},"response":[{"id":"c1d28a69-0636-4a8e-9ae1-f65986e107a6","name":"Get Knowledge Base","originalRequest":{"method":"GET","header":[],"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}/knowledge-base/{knowledgeBaseId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"632","enabled":true},{"key":"ETag","value":"W/\"278-uZL5fRlyb6dTybsvec3Bmb1g9bI\"","enabled":true},{"key":"Date","value":"Thu, 01 Aug 2024 09:05:12 GMT","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Keep-Alive","value":"timeout=5","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"Knowledge Base fetched\",\n    \"data\": {\n        \"_id\": \"66ab4edccd6be7af3a76a457\",\n        \"name\": \"Product details\",\n        \"description\": \"This web page contains all the product information\",\n        \"resourceType\": \"qa\",\n        \"resource\": [\n            {\n                \"question\": \"Hello this is the first question\",\n                \"answer\": \"This is how you answer the above question\"\n            },\n            {\n                \"question\": \"Hello this is the second question\",\n                \"answer\": \"This is how you answer the above question\"\n            }\n        ],\n        \"extractedContent\": \"Hello this is the first question This is how you answer the above question Hello this is the second question This is how you answer the above question \",\n        \"fromTemplate\": false,\n        \"status\": \"extraction_completed\"\n    }\n}"}],"_postman_id":"8a12fb0c-e004-46fa-8691-a49c7940c352"},{"name":"Create Knowledge Base - Document","id":"2344f04a-1c88-457e-96a4-94c38b3c0d15","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"About Company","type":"text"},{"key":"description","value":"This document contains the agency offerings and expertise","type":"text"},{"key":"documents[]","type":"file","src":"/Users/nitish/Downloads/Star Realtors.docx"}]},"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}/knowledge-base/document","description":"<p>Creates a knowledge base of <em>document</em> type for the chatbot.</p>\n<p><strong>Path Parameters:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Param</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>projectId</td>\n<td>The ID of the project in which chatbot is created.</td>\n</tr>\n<tr>\n<td>chatbotId</td>\n<td>The ID of the chatbot.</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"bearer","bearer":{"token":"{apiKey}"},"isInherited":true,"source":{"_postman_id":"03fe9768-f867-473e-9b29-d0fdb11e002d","id":"03fe9768-f867-473e-9b29-d0fdb11e002d","name":"TymBot","type":"collection"}},"urlObject":{"path":["pub","projects","{projectId}","chatbots","{chatbotId}","knowledge-base","document"],"host":["https://server.tymbot.io/api/v1"],"query":[],"variable":[]}},"response":[{"id":"49a83a2b-1426-4e30-8db9-67ef850bde2d","name":"Create Knowledge Base - Document","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"About Company","type":"text"},{"key":"description","value":"This document contains the agency offerings and expertise","type":"text"},{"key":"documents[]","type":"file","src":["/Users/nitish/Downloads/Star Realtors.docx"]}]},"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}/knowledge-base/document"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"327","enabled":true},{"key":"ETag","value":"W/\"147-rQS1g5E0JUWURMDqGUXykdwTpvQ\"","enabled":true},{"key":"Date","value":"Thu, 01 Aug 2024 08:58:47 GMT","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Keep-Alive","value":"timeout=5","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"Knowledge Base added to chatbot\",\n    \"data\": {\n        \"name\": \"About Company\",\n        \"description\": \"This document contains the agency offerings and expertise\",\n        \"resourceType\": \"document\",\n        \"resource\": {\n            \"originalFilenames\": [\n                \"Star Realtors.docx\"\n            ]\n        },\n        \"extractedContent\": \"\",\n        \"fromTemplate\": false,\n        \"status\": \"latent\",\n        \"_id\": \"66ab4e47cd6be7af3a76a33c\"\n    }\n}"}],"_postman_id":"2344f04a-1c88-457e-96a4-94c38b3c0d15"},{"name":"Create Knowledge Base - Web page","id":"da465554-8c67-4fe8-8e93-2618950131ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"name\" : \"Landing Page\",\r\n    \"description\" : \"This web page contains details about the product\",\r\n    \"urls\" : [\"https://www.tymbot.io/\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}/knowledge-base/web-page","description":"<p>Creates a knowledge base of <em>web page</em> type for the chatbot.</p>\n<p><strong>Path Parameters:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Param</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>projectId</td>\n<td>The ID of the project in which chatbot is created.</td>\n</tr>\n<tr>\n<td>chatbotId</td>\n<td>The ID of the chatbot.</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"bearer","bearer":{"token":"{apiKey}"},"isInherited":true,"source":{"_postman_id":"03fe9768-f867-473e-9b29-d0fdb11e002d","id":"03fe9768-f867-473e-9b29-d0fdb11e002d","name":"TymBot","type":"collection"}},"urlObject":{"path":["pub","projects","{projectId}","chatbots","{chatbotId}","knowledge-base","web-page"],"host":["https://server.tymbot.io/api/v1"],"query":[],"variable":[]}},"response":[{"id":"16b614b6-b072-4bb6-bf21-1c6263bd8cfd","name":"Create Knowledge Base - Web page","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"name\" : \"Landing Page\",\r\n    \"description\" : \"This web page contains details about the product\",\r\n    \"urls\" : [\"https://www.tymbot.io/\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}/knowledge-base/web-page"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"307","enabled":true},{"key":"ETag","value":"W/\"133-s0TFkjJNte8MP5Dlqv6OaZWIAuE\"","enabled":true},{"key":"Date","value":"Thu, 01 Aug 2024 09:00:56 GMT","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Keep-Alive","value":"timeout=5","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"Knowledge Base added to chatbot\",\n    \"data\": {\n        \"name\": \"Landing Page\",\n        \"description\": \"This web page contains details about the product\",\n        \"resourceType\": \"webpage\",\n        \"resource\": {\n            \"urls\": [\n                \"https://www.tymbot.io/\"\n            ]\n        },\n        \"extractedContent\": \"\",\n        \"fromTemplate\": false,\n        \"status\": \"latent\",\n        \"_id\": \"66ab4ec7cd6be7af3a76a3cf\"\n    }\n}"}],"_postman_id":"da465554-8c67-4fe8-8e93-2618950131ea"},{"name":"Create Knowledge Base - QA","id":"2795f23c-689b-472e-bb4a-5fae31f67545","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"name\" : \"Product details\",\r\n    \"description\" : \"This web page contains all the product information\",\r\n    \"data\" : [\r\n        {\r\n            \"question\" : \"Hello this is the first question\",\r\n            \"answer\" : \"This is how you answer the above question\"\r\n        },\r\n        {\r\n           \"question\" : \"Hello this is the second question\",\r\n            \"answer\" : \"This is how you answer the above question\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}/knowledge-base/qa","description":"<p>Creates a knowledge base of <em>QA</em> type for the chatbot.</p>\n<p><strong>Path Parameters:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Param</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>projectId</td>\n<td>The ID of the project in which chatbot is created.</td>\n</tr>\n<tr>\n<td>chatbotId</td>\n<td>The ID of the chatbot.</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"bearer","bearer":{"token":"{apiKey}"},"isInherited":true,"source":{"_postman_id":"03fe9768-f867-473e-9b29-d0fdb11e002d","id":"03fe9768-f867-473e-9b29-d0fdb11e002d","name":"TymBot","type":"collection"}},"urlObject":{"path":["pub","projects","{projectId}","chatbots","{chatbotId}","knowledge-base","qa"],"host":["https://server.tymbot.io/api/v1"],"query":[],"variable":[]}},"response":[{"id":"641470ec-7e14-4fa3-826b-28ce8e9dbb1b","name":"Create Knowledge Base - QA","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"name\" : \"Product details\",\r\n    \"description\" : \"This web page contains all the product information\",\r\n    \"data\" : [\r\n        {\r\n            \"question\" : \"Hello this is the first question\",\r\n            \"answer\" : \"This is how you answer the above question\"\r\n        },\r\n        {\r\n           \"question\" : \"Hello this is the second question\",\r\n            \"answer\" : \"This is how you answer the above question\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}/knowledge-base/qa"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"476","enabled":true},{"key":"ETag","value":"W/\"1dc-vzL9eMlgIZqDVESlfTsYRmvQFJI\"","enabled":true},{"key":"Date","value":"Thu, 01 Aug 2024 09:01:16 GMT","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Keep-Alive","value":"timeout=5","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"Knowledge Base added to chatbot\",\n    \"data\": {\n        \"name\": \"Product details\",\n        \"description\": \"This web page contains all the product information\",\n        \"resourceType\": \"qa\",\n        \"resource\": [\n            {\n                \"question\": \"Hello this is the first question\",\n                \"answer\": \"This is how you answer the above question\"\n            },\n            {\n                \"question\": \"Hello this is the second question\",\n                \"answer\": \"This is how you answer the above question\"\n            }\n        ],\n        \"extractedContent\": \"\",\n        \"fromTemplate\": false,\n        \"status\": \"latent\",\n        \"_id\": \"66ab4edccd6be7af3a76a457\"\n    }\n}"}],"_postman_id":"2795f23c-689b-472e-bb4a-5fae31f67545"},{"name":"Create Knowledge Base - Media","id":"2cf10b47-5748-47b7-b597-eccf9e05557c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Europe Tourism Package","type":"text"},{"key":"description","value":"This media covers the details of Europe holiday package","type":"text"},{"key":"content","value":"Discover the enchanting allure of Europe with our exclusive holiday package that includes the iconic city of Paris. This unforgettable journey will take you through the heart of Europe, offering a perfect blend of culture, history, and romance.\n\n**Paris - The City of Lights:** Begin your adventure in Paris, the epitome of elegance and charm. Stroll along the picturesque Seine River, marvel at the stunning architecture of the Eiffel Tower, and explore world-renowned museums like the Louvre and Musée d'Orsay. Indulge in exquisite French cuisine at charming bistros and cafes, and experience the vibrant atmosphere of Montmartre, the city's artistic hub.\n\nThis holiday package includes guided tours of Paris's most famous landmarks, comfortable accommodations, and ample free time to explore the city's hidden gems at your leisure. Whether you're sipping coffee at a quaint café or shopping along the Champs-Élysées, Paris promises an unforgettable experience that will leave you longing to return.","type":"text"},{"key":"attachments[]","type":"file","src":"/Users/nitish/Downloads/what-is-paris-famous-for-eiffel-tower-1366x2048.jpg"}]},"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}/knowledge-base/media","description":"<p>Creates a knowledge base of <em>media</em> type for the chatbot.</p>\n<p><strong>Path Parameters:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Param</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>projectId</td>\n<td>The ID of the project in which chatbot is created.</td>\n</tr>\n<tr>\n<td>chatbotId</td>\n<td>The ID of the chatbot.</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"bearer","bearer":{"token":"{apiKey}"},"isInherited":true,"source":{"_postman_id":"03fe9768-f867-473e-9b29-d0fdb11e002d","id":"03fe9768-f867-473e-9b29-d0fdb11e002d","name":"TymBot","type":"collection"}},"urlObject":{"path":["pub","projects","{projectId}","chatbots","{chatbotId}","knowledge-base","media"],"host":["https://server.tymbot.io/api/v1"],"query":[],"variable":[]}},"response":[{"id":"2d459a0a-dd90-4817-aaa3-601678c177fd","name":"Create Knowledge Base - Media","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Europe Tourism Package","type":"text"},{"key":"description","value":"This media covers the details of Europe holiday package","type":"text"},{"key":"content","value":"Discover the enchanting allure of Europe with our exclusive holiday package that includes the iconic city of Paris. This unforgettable journey will take you through the heart of Europe, offering a perfect blend of culture, history, and romance.\n\n**Paris - The City of Lights:** Begin your adventure in Paris, the epitome of elegance and charm. Stroll along the picturesque Seine River, marvel at the stunning architecture of the Eiffel Tower, and explore world-renowned museums like the Louvre and Musée d'Orsay. Indulge in exquisite French cuisine at charming bistros and cafes, and experience the vibrant atmosphere of Montmartre, the city's artistic hub.\n\nThis holiday package includes guided tours of Paris's most famous landmarks, comfortable accommodations, and ample free time to explore the city's hidden gems at your leisure. Whether you're sipping coffee at a quaint café or shopping along the Champs-Élysées, Paris promises an unforgettable experience that will leave you longing to return.","type":"text"},{"key":"attachments[]","type":"file","src":["/Users/nitish/Downloads/what-is-paris-famous-for-eiffel-tower-1366x2048.jpg"]}]},"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}/knowledge-base/media"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"1362","enabled":true},{"key":"ETag","value":"W/\"552-xPVW0prS9WY0ITJibnGoE3D5IP0\"","enabled":true},{"key":"Date","value":"Thu, 01 Aug 2024 09:03:16 GMT","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Keep-Alive","value":"timeout=5","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"Knowledge Base added to chatbot\",\n    \"data\": {\n        \"name\": \"Europe Tourism Package\",\n        \"description\": \"This media covers the details of Europe holiday package\",\n        \"resourceType\": \"media\",\n        \"resource\": {\n            \"content\": \"Discover the enchanting allure of Europe with our exclusive holiday package that includes the iconic city of Paris. This unforgettable journey will take you through the heart of Europe, offering a perfect blend of culture, history, and romance.\\n\\n**Paris - The City of Lights:** Begin your adventure in Paris, the epitome of elegance and charm. Stroll along the picturesque Seine River, marvel at the stunning architecture of the Eiffel Tower, and explore world-renowned museums like the Louvre and Musée d'Orsay. Indulge in exquisite French cuisine at charming bistros and cafes, and experience the vibrant atmosphere of Montmartre, the city's artistic hub.\\n\\nThis holiday package includes guided tours of Paris's most famous landmarks, comfortable accommodations, and ample free time to explore the city's hidden gems at your leisure. Whether you're sipping coffee at a quaint café or shopping along the Champs-Élysées, Paris promises an unforgettable experience that will leave you longing to return.\",\n            \"attachments\": [\n                {\n                    \"file\": \"66ab4f53cd6be7af3a76a4e9\"\n                }\n            ]\n        },\n        \"extractedContent\": \"\",\n        \"fromTemplate\": false,\n        \"status\": \"latent\",\n        \"_id\": \"66ab4f54cd6be7af3a76a4eb\"\n    }\n}"}],"_postman_id":"2cf10b47-5748-47b7-b597-eccf9e05557c"},{"name":"Update Knowledge Base Details","id":"5b577038-d1d0-423e-9214-f1bc75f9b7b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n    \"name\" : \"Product details\",\r\n    \"description\" : \"This web page contains all the product information\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}/knowledge-base/{knowledgeBaseId}","description":"<p>Updates the name and description of the knowledge base.</p>\n<p><strong>Path Parameters:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Param</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>projectId</td>\n<td>The ID of the project in which chatbot is created.</td>\n</tr>\n<tr>\n<td>chatbotId</td>\n<td>The ID of the chatbot.</td>\n</tr>\n<tr>\n<td>knowledgeBaseId</td>\n<td>The ID of the knowledge base.</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"bearer","bearer":{"token":"{apiKey}"},"isInherited":true,"source":{"_postman_id":"03fe9768-f867-473e-9b29-d0fdb11e002d","id":"03fe9768-f867-473e-9b29-d0fdb11e002d","name":"TymBot","type":"collection"}},"urlObject":{"path":["pub","projects","{projectId}","chatbots","{chatbotId}","knowledge-base","{knowledgeBaseId}"],"host":["https://server.tymbot.io/api/v1"],"query":[],"variable":[]}},"response":[{"id":"80eb10f3-dbd1-4bd3-8a61-31b76654959f","name":"Update Knowledge Base Details","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n    \"name\" : \"Product details\",\r\n    \"description\" : \"This web page contains all the product information\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}/knowledge-base/{knowledgeBaseId}"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"X-Powered-By","value":"Express","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"ETag","value":"W/\"36-iE84E2IIDMkDNmVOAP8cV/qpCbk\"","enabled":true},{"key":"Date","value":"Thu, 01 Aug 2024 09:06:45 GMT","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Keep-Alive","value":"timeout=5","enabled":true}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"5b577038-d1d0-423e-9214-f1bc75f9b7b3"},{"name":"Update Knowledge Base Content","id":"c523d284-73f5-461e-b407-e423d005bdf2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n    \"content\" : \"Put in the updated content of the knowledge base here. This overwrites the existing knowledge base content.\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}/knowledge-base/{knowledgeBaseId}/content","description":"<p>Updates the content of <em>document</em> or <em>web page</em> type knowledge base. Remember to <a href=\"https://www.postman.com/apnatomy-developers/workspace/apnatomy/documentation/37376001-03fe9768-f867-473e-9b29-d0fdb11e002d?entity=request-7b980dfd-3689-4633-81d6-cf7c223b216a\">Sync Knowledge Base to Chatbot </a> after updating the content to feed the chatbot.</p>\n<p><strong>Path Parameters:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Param</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>projectId</td>\n<td>The ID of the project in which chatbot is created.</td>\n</tr>\n<tr>\n<td>chatbotId</td>\n<td>The ID of the chatbot.</td>\n</tr>\n<tr>\n<td>knowledgeBaseId</td>\n<td>The ID of the knowledge base.</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"bearer","bearer":{"token":"{apiKey}"},"isInherited":true,"source":{"_postman_id":"03fe9768-f867-473e-9b29-d0fdb11e002d","id":"03fe9768-f867-473e-9b29-d0fdb11e002d","name":"TymBot","type":"collection"}},"urlObject":{"path":["pub","projects","{projectId}","chatbots","{chatbotId}","knowledge-base","{knowledgeBaseId}","content"],"host":["https://server.tymbot.io/api/v1"],"query":[],"variable":[]}},"response":[{"id":"6259cb44-3462-4059-8291-537539ed87b0","name":"Update Knowledge Base Content","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n    \"content\" : \"Put in the updated content of the knowledge base here. This overwrites the existing knowledge base content.\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}/knowledge-base/{knowledgeBaseId}/content"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"447","enabled":true},{"key":"ETag","value":"W/\"1bf-ksKybpG9YRTsJPMOsQabdaoQ2Tw\"","enabled":true},{"key":"Date","value":"Thu, 01 Aug 2024 09:12:57 GMT","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Keep-Alive","value":"timeout=5","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"Knowledge Base content updated\",\n    \"data\": {\n        \"_id\": \"66ab4e47cd6be7af3a76a33c\",\n        \"name\": \"About Company\",\n        \"description\": \"This document contains the agency offerings and expertise\",\n        \"resourceType\": \"document\",\n        \"resource\": {\n            \"originalFilenames\": [\n                \"Star Realtors.docx\"\n            ]\n        },\n        \"extractedContent\": \"Put in the updated content of the knowledge base here. This overwrites the existing knowledge base content.\",\n        \"fromTemplate\": false,\n        \"status\": \"extraction_completed\"\n    }\n}"}],"_postman_id":"c523d284-73f5-461e-b407-e423d005bdf2"},{"name":"Update Knowledge Base - QA","id":"ef777399-baaf-4525-a41a-962204e4ec45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n    \"data\" : [\r\n        {\r\n            \"question\" : \"Hello this is the first question\",\r\n            \"answer\" : \"This is how you answer the above question\"\r\n        },\r\n        {\r\n           \"question\" : \"Hello this is the second question\",\r\n            \"answer\" : \"This is how you answer the above question\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}/knowledge-base/{knowledgeBaseId}/qa","description":"<p>Updates the content of <em>QA</em> type knowledge base.</p>\n<p><strong>Path Parameters:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Param</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>projectId</td>\n<td>The ID of the project in which chatbot is created.</td>\n</tr>\n<tr>\n<td>chatbotId</td>\n<td>The ID of the chatbot.</td>\n</tr>\n<tr>\n<td>knowledgeBaseId</td>\n<td>The ID of the knowledge base.</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"bearer","bearer":{"token":"{apiKey}"},"isInherited":true,"source":{"_postman_id":"03fe9768-f867-473e-9b29-d0fdb11e002d","id":"03fe9768-f867-473e-9b29-d0fdb11e002d","name":"TymBot","type":"collection"}},"urlObject":{"path":["pub","projects","{projectId}","chatbots","{chatbotId}","knowledge-base","{knowledgeBaseId}","qa"],"host":["https://server.tymbot.io/api/v1"],"query":[],"variable":[]}},"response":[{"id":"248140d7-7b0c-4dfb-bfee-d14108047cdb","name":"Update Knowledge Base - QA","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n    \"data\" : [\r\n        {\r\n            \"question\" : \"Hello this is the first question\",\r\n            \"answer\" : \"This is how you answer the above question\"\r\n        },\r\n        {\r\n           \"question\" : \"Hello this is the second question\",\r\n            \"answer\" : \"This is how you answer the above question\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}/knowledge-base/{knowledgeBaseId}/qa"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"640","enabled":true},{"key":"ETag","value":"W/\"280-OiM0btEEV6Ejcx3cDGvBAV1M9Vs\"","enabled":true},{"key":"Date","value":"Thu, 01 Aug 2024 09:17:29 GMT","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Keep-Alive","value":"timeout=5","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"Knowledge Base content updated\",\n    \"data\": {\n        \"_id\": \"66ab4edccd6be7af3a76a457\",\n        \"name\": \"Product details\",\n        \"description\": \"This web page contains all the product information\",\n        \"resourceType\": \"qa\",\n        \"resource\": [\n            {\n                \"question\": \"Hello this is the first question\",\n                \"answer\": \"This is how you answer the above question\"\n            },\n            {\n                \"question\": \"Hello this is the second question\",\n                \"answer\": \"This is how you answer the above question\"\n            }\n        ],\n        \"extractedContent\": \"Hello this is the first question This is how you answer the above question Hello this is the second question This is how you answer the above question \",\n        \"fromTemplate\": false,\n        \"status\": \"extraction_completed\"\n    }\n}"}],"_postman_id":"ef777399-baaf-4525-a41a-962204e4ec45"},{"name":"Update Knowledge Base - Media","id":"b1d29206-a6a8-4b20-896b-cb1c8038888e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"formdata","formdata":[{"key":"content","value":"Discover the enchanting allure of Europe with our exclusive holiday package that includes the iconic city of Paris. This unforgettable journey will take you through the heart of Europe, offering a perfect blend of culture, history, and romance.\n\nParis - The City of Lights: Begin your adventure in Paris, the epitome of elegance and charm. Stroll along the picturesque Seine River, marvel at the stunning architecture of the Eiffel Tower, and explore world-renowned museums like the Louvre and Musée d'Orsay. Indulge in exquisite French cuisine at charming bistros and cafes, and experience the vibrant atmosphere of Montmartre, the city's artistic hub.\n\nThis holiday package includes guided tours of Paris's most famous landmarks, comfortable accommodations, and ample free time to explore the city's hidden gems at your leisure. Whether you're sipping coffee at a quaint café or shopping along the Champs-Élysées, Paris promises an unforgettable experience that will leave you longing to return.","type":"text"},{"key":"attachments[]","type":"file","src":"/Users/nitish/Downloads/what-is-paris-famous-for-eiffel-tower-1366x2048.jpg"}]},"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}/knowledge-base/{knowledgeBaseId}/media","description":"<p>Updates the content and attachments of <em>media</em> type knowledge base.</p>\n<p><strong>Path Parameters:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Param</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>projectId</td>\n<td>The ID of the project in which chatbot is created.</td>\n</tr>\n<tr>\n<td>chatbotId</td>\n<td>The ID of the chatbot.</td>\n</tr>\n<tr>\n<td>knowledgeBaseId</td>\n<td>The ID of the knowledge base.</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"bearer","bearer":{"token":"{apiKey}"},"isInherited":true,"source":{"_postman_id":"03fe9768-f867-473e-9b29-d0fdb11e002d","id":"03fe9768-f867-473e-9b29-d0fdb11e002d","name":"TymBot","type":"collection"}},"urlObject":{"path":["pub","projects","{projectId}","chatbots","{chatbotId}","knowledge-base","{knowledgeBaseId}","media"],"host":["https://server.tymbot.io/api/v1"],"query":[],"variable":[]}},"response":[{"id":"8fe0f361-ed03-4390-ac79-008b32676e9c","name":"Update Knowledge Base - Media","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"formdata","formdata":[{"key":"content","value":"Discover the enchanting allure of Europe with our exclusive holiday package that includes the iconic city of Paris. This unforgettable journey will take you through the heart of Europe, offering a perfect blend of culture, history, and romance.\n\nParis - The City of Lights: Begin your adventure in Paris, the epitome of elegance and charm. Stroll along the picturesque Seine River, marvel at the stunning architecture of the Eiffel Tower, and explore world-renowned museums like the Louvre and Musée d'Orsay. Indulge in exquisite French cuisine at charming bistros and cafes, and experience the vibrant atmosphere of Montmartre, the city's artistic hub.\n\nThis holiday package includes guided tours of Paris's most famous landmarks, comfortable accommodations, and ample free time to explore the city's hidden gems at your leisure. Whether you're sipping coffee at a quaint café or shopping along the Champs-Élysées, Paris promises an unforgettable experience that will leave you longing to return.","type":"text"},{"key":"attachments[]","type":"file","src":["/Users/nitish/Downloads/what-is-paris-famous-for-eiffel-tower-1366x2048.jpg"]}]},"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}/knowledge-base/{knowledgeBaseId}/media"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"2442","enabled":true},{"key":"ETag","value":"W/\"98a-SD+2ZsoRmPesEmAmbdFYFLuuZ28\"","enabled":true},{"key":"Date","value":"Thu, 01 Aug 2024 09:21:28 GMT","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Keep-Alive","value":"timeout=5","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"Knowledge Base content updated\",\n    \"data\": {\n        \"_id\": \"66ab4f54cd6be7af3a76a4eb\",\n        \"name\": \"Europe Tourism Package\",\n        \"description\": \"This media covers the details of Europe holiday package\",\n        \"resourceType\": \"media\",\n        \"resource\": {\n            \"content\": \"Discover the enchanting allure of Europe with our exclusive holiday package that includes the iconic city of Paris. This unforgettable journey will take you through the heart of Europe, offering a perfect blend of culture, history, and romance.\\n\\nParis - The City of Lights: Begin your adventure in Paris, the epitome of elegance and charm. Stroll along the picturesque Seine River, marvel at the stunning architecture of the Eiffel Tower, and explore world-renowned museums like the Louvre and Musée d'Orsay. Indulge in exquisite French cuisine at charming bistros and cafes, and experience the vibrant atmosphere of Montmartre, the city's artistic hub.\\n\\nThis holiday package includes guided tours of Paris's most famous landmarks, comfortable accommodations, and ample free time to explore the city's hidden gems at your leisure. Whether you're sipping coffee at a quaint café or shopping along the Champs-Élysées, Paris promises an unforgettable experience that will leave you longing to return.\",\n            \"attachments\": [\n                {\n                    \"file\": \"66ab4f53cd6be7af3a76a4e9\"\n                },\n                {\n                    \"file\": \"66ab53061649690986229153\"\n                },\n                {\n                    \"file\": \"66ab539643355a2d9876ad20\"\n                }\n            ]\n        },\n        \"extractedContent\": \"Discover the enchanting allure of Europe with our exclusive holiday package that includes the iconic city of Paris. This unforgettable journey will take you through the heart of Europe, offering a perfect blend of culture, history, and romance. Paris - The City of Lights: Begin your adventure in Paris, the epitome of elegance and charm. Stroll along the picturesque Seine River, marvel at the stunning architecture of the Eiffel Tower, and explore world-renowned museums like the Louvre and Musée d'Orsay. Indulge in exquisite French cuisine at charming bistros and cafes, and experience the vibrant atmosphere of Montmartre, the city's artistic hub. This holiday package includes guided tours of Paris's most famous landmarks, comfortable accommodations, and ample free time to explore the city's hidden gems at your leisure. Whether you're sipping coffee at a quaint café or shopping along the Champs-Élysées, Paris promises an unforgettable experience that will leave you longing to return.\",\n        \"fromTemplate\": false,\n        \"status\": \"extraction_completed\"\n    }\n}"}],"_postman_id":"b1d29206-a6a8-4b20-896b-cb1c8038888e"},{"name":"Get Media File Of Knowledge Base","id":"39c2e4af-5767-4b16-8938-b2bdc08cf542","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}/knowledge-base/{knowledgeBaseId}/media/attachments/{knowledgeBaseMediaAttachmentId}","description":"<p>Get a temporary URL to view the media attachment of the knowledge base.</p>\n<p><strong>Path Parameters:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Param</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>projectId</td>\n<td>The ID of the project in which chatbot is created.</td>\n</tr>\n<tr>\n<td>chatbotId</td>\n<td>The ID of the chatbot.</td>\n</tr>\n<tr>\n<td>knowledgeBaseId</td>\n<td>The ID of the knowledge base.</td>\n</tr>\n<tr>\n<td>knowledgeBaseMediaAttachmentId</td>\n<td>The ID of the media attachment.</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"bearer","bearer":{"token":"{apiKey}"},"isInherited":true,"source":{"_postman_id":"03fe9768-f867-473e-9b29-d0fdb11e002d","id":"03fe9768-f867-473e-9b29-d0fdb11e002d","name":"TymBot","type":"collection"}},"urlObject":{"path":["pub","projects","{projectId}","chatbots","{chatbotId}","knowledge-base","{knowledgeBaseId}","media","attachments","{knowledgeBaseMediaAttachmentId}"],"host":["https://server.tymbot.io/api/v1"],"query":[],"variable":[]}},"response":[{"id":"027abefc-c1e9-4690-97fd-cef08fe6ba6f","name":"Get Media File Of Knowledge Base","originalRequest":{"method":"GET","header":[],"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}/knowledge-base/{knowledgeBaseId}/media/attachments/{knowledgeBaseMediaAttachmentId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"512","enabled":true},{"key":"ETag","value":"W/\"200-uBg/aTWCTIjJxokPJCMoYL9uZDY\"","enabled":true},{"key":"Date","value":"Thu, 01 Aug 2024 09:23:52 GMT","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Keep-Alive","value":"timeout=5","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"Knowledge base media file fetched\",\n    \"data\": \"https://abcdef-strg-s3.s3.us-east-1.amazonaws.com/uploads/65c5d36c89856a45826507d3/kb_media_file_1722502990457_792956567.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential={{vault:aws-access-key}}%2F20240801%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240801T092352Z&X-Amz-Expires=3600&X-Amz-Signature=221c31b0f31d0d6f470a7b0cebd7b062847f9a62926290d46041d1c0089a03ef&X-Amz-SignedHeaders=host&x-id=GetObject\" \n}"}],"_postman_id":"39c2e4af-5767-4b16-8938-b2bdc08cf542"},{"name":"Delete Knowledge Base","id":"39526f7e-e150-4eae-987c-3aa797f3d6f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}/knowledge-base/{knowledgeBaseId}","description":"<p>Deletes a knowledge base.</p>\n<p><strong>Path Parameters:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Param</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>projectId</td>\n<td>The ID of the project in which chatbot is created.</td>\n</tr>\n<tr>\n<td>chatbotId</td>\n<td>The ID of the chatbot.</td>\n</tr>\n<tr>\n<td>knowledgeBaseId</td>\n<td>The ID of the knowledge base.</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"bearer","bearer":{"token":"{apiKey}"},"isInherited":true,"source":{"_postman_id":"03fe9768-f867-473e-9b29-d0fdb11e002d","id":"03fe9768-f867-473e-9b29-d0fdb11e002d","name":"TymBot","type":"collection"}},"urlObject":{"path":["pub","projects","{projectId}","chatbots","{chatbotId}","knowledge-base","{knowledgeBaseId}"],"host":["https://server.tymbot.io/api/v1"],"query":[],"variable":[]}},"response":[{"id":"982f7e0f-be30-4823-96eb-c4435618fd64","name":"Delete Knowledge Base","originalRequest":{"method":"DELETE","header":[],"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}/knowledge-base/{knowledgeBaseId}"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"X-Powered-By","value":"Express","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"ETag","value":"W/\"2e-8rlF/rLnX1HtvpPh04sf2KbJ0Kc\"","enabled":true},{"key":"Date","value":"Thu, 01 Aug 2024 09:25:23 GMT","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Keep-Alive","value":"timeout=5","enabled":true}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"39526f7e-e150-4eae-987c-3aa797f3d6f3"},{"name":"Sync Knowledge Base To Chatbot","id":"7b980dfd-3689-4633-81d6-cf7c223b216a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}/sync-knowledge-base","description":"<p>Sync the latest knowledge base changes to the chatbot after adding or updating sources.</p>\n<p><strong>Path Parameters:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Param</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>projectId</td>\n<td>The ID of the project in which chatbot is created.</td>\n</tr>\n<tr>\n<td>chatbotId</td>\n<td>The ID of the chatbot.</td>\n</tr>\n<tr>\n<td>knowledgeBaseId</td>\n<td>The ID of the knowledge base.</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"bearer","bearer":{"token":"{apiKey}"},"isInherited":true,"source":{"_postman_id":"03fe9768-f867-473e-9b29-d0fdb11e002d","id":"03fe9768-f867-473e-9b29-d0fdb11e002d","name":"TymBot","type":"collection"}},"urlObject":{"path":["pub","projects","{projectId}","chatbots","{chatbotId}","sync-knowledge-base"],"host":["https://server.tymbot.io/api/v1"],"query":[],"variable":[]}},"response":[{"id":"c29b930f-ce40-4db0-b2d2-7ba38d0d00d7","name":"Sync Knowledge Base To Chatbot","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://server.tymbot.io/api/v1/pub/projects/{projectId}/chatbots/{chatbotId}/sync-knowledge-base"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"50","enabled":true},{"key":"ETag","value":"W/\"32-KwXp3jnKp3LRpzgOEpM3Bv+2To0\"","enabled":true},{"key":"Date","value":"Thu, 01 Aug 2024 09:25:35 GMT","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Keep-Alive","value":"timeout=5","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"Chatbot generation started\",\n    \"data\": {}\n}"}],"_postman_id":"7b980dfd-3689-4633-81d6-cf7c223b216a"}],"auth":{"type":"bearer","bearer":{"token":"{apiKey}"}},"event":[{"listen":"prerequest","script":{"id":"9c411b0b-4239-400d-87e3-1be182b00829","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"620de78d-c0ee-47d8-87a1-3a2b1515f8ce","type":"text/javascript","exec":[""]}}],"variable":[{"key":"apiKey","value":"{apiKey}"},{"key":"baseURL","value":"https://server.tymbot.io/api/v1"},{"key":"projectId","value":"{projectId}"},{"key":"chatbotId","value":"{chatbotId}"},{"key":"knowledgeBaseId","value":"{knowledgeBaseId}"},{"key":"knowledgeBaseMediaAttachmentId","value":"{knowledgeBaseMediaAttachmentId}"}]}