Thank you for choosing Zetaboto, an advanced AI-powered chatbot designed to seamlessly integrate into any website. This comprehensive API documentation will guide you through the process of embedding Zetaboto's intelligent chatbot functionality into your web application using public APIs. With Zetaboto, you can enhance user engagement, provide real-time assistance, and offer a personalized experience to your website visitors.
\nFor getting project configuration, chatbot answers and sending feedback, ratings, you don't need any authorization headers in your HTTPS request.
\nFor every request to public APIs must include one parameter - 'projectId'. This is a typical UUID v4 string made for project identification and you can get this project ID by contacting our support team (support@zetaboto.com).
\nFor getting analytics data and downloading CSV file, you need to include Authorization header mentioned in the below.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"👋 Thanks!","slug":"thanks"},{"content":"Authorization","slug":"authorization"}],"owner":"28327876","collectionId":"a79ad773-f5f2-4626-af2e-4aeba6978cfa","publishedId":"2s9Y5YSNU8","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-08-27T12:55:12.000Z"},"item":[{"name":"Public APIs","item":[{"name":"Get Project Configuration","id":"0e95f0df-f82c-4208-848e-12eebb2c2979","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.zetaboto.com/api/v1/chat/config?projectId=1e6c26e5-26a9-4673-8271-d08e9fb2c2e3","description":"Getting your chatbot customization data.
\n","urlObject":{"protocol":"https","path":["api","v1","chat","config"],"host":["api","zetaboto","com"],"query":[{"description":{"content":"Project ID
\n","type":"text/plain"},"key":"projectId","value":"1e6c26e5-26a9-4673-8271-d08e9fb2c2e3"}],"variable":[]}},"response":[{"id":"3a460f97-e13e-4323-9423-8e90ad8177d1","name":"Sample Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.zetaboto.com/api/v1/chat/config?projectId=1e6c26e5-26a9-4673-8271-d08e9fb2c2e3","protocol":"https","host":["api","zetaboto","com"],"path":["api","v1","chat","config"],"query":[{"key":"projectId","value":"1e6c26e5-26a9-4673-8271-d08e9fb2c2e3","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"550"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Sun, 27 Aug 2023 12:33:07 GMT"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"226-RUxXFKiUrZ9WIGieHaS9zYqSoEU\""},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 3d3fd40be4e4bfdd1e1bebf86df63a76.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD55-P1"},{"key":"X-Amz-Cf-Id","value":"Wrpp_qRHAwXzsP4IJi31vodXDjNGHSyBSmDJE8weafrDCgoxXkYPaQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"botAvatarUrl\": \"https://storage.zetaboto.com/logos/7424eccc-1a98-41d5-8fba-232ea297e0b6-cropped-image.png\",\n \"botName\": \"Nicosia Municipality Virtual Assistant\",\n \"fabBgColor\": \"#0068b3\",\n \"fabIconColor\": null,\n \"fabHoverBgColor\": null,\n \"fabHoverIconColor\": null,\n \"fabWidth\": null,\n \"fabHeight\": null,\n \"fabRippleColor\": \"#0068b3\",\n \"fabGuideBgColor\": null,\n \"fabGuideFontColor\": null,\n \"fabGuideText\": \"👋🏼 Hello, how can I help you?\",\n \"headerBgColor\": \"#0068b3\",\n \"headerFontColor\": null,\n \"contentBubbleBgColor\": null,\n \"contentFontColor\": null,\n \"contentFontSize\": null,\n \"projectId\": 13\n}"}],"_postman_id":"0e95f0df-f82c-4208-848e-12eebb2c2979"},{"name":"Get Chatbot Answer","id":"a0c166ee-3d62-40e6-87af-e442614cc4b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"projectId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\r\n \"initial\": false, // true for getting initial greetings and actions data, false for getting answers based on users' questions\r\n \"message\": \"Is there any place for drinking inside the building?\", // if initial is true, any message, otherwise user question\r\n \"sessionId\": 1234 // session ID from initial request, for initial request, don't include this field\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.zetaboto.com/api/v1/chat","urlObject":{"protocol":"https","path":["api","v1","chat"],"host":["api","zetaboto","com"],"query":[],"variable":[]}},"response":[{"id":"02132209-57be-4e79-b120-475518f3e6a4","name":"Getting initial data","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"projectId\": \"1e6c26e5-26a9-4673-8271-d08e9fb2c2e4\",\r\n \"initial\": true,\r\n \"message\": \"Hello\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.zetaboto.com/api/v1/chat"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"612"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Sun, 27 Aug 2023 12:42:41 GMT"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"264-cNNEUiWYG1+JzxS+74g60f5iYoY\""},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 69baaa5439c683e230d9fcac1c2ffce0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD55-P1"},{"key":"X-Amz-Cf-Id","value":"Moz4RN3UDiAzsSmYbgzEwMOYSBNju-PofFS4FYM8Tl7gdztgkhD7bw=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": \"Hello and welcome to Nicosia. I'm your virtual assistant and I can speak any language. How may I help you today? 😊\",\n \"sessionId\": 1340,\n \"actions\": [\n {\n \"id\": 41,\n \"title\": \"🏤 Museums\",\n \"color\": \"#0068b3\",\n \"type\": \"link\",\n \"data\": \"test\",\n \"fontColor\": \"#ffffff\"\n },\n {\n \"id\": 42,\n \"title\": \"🍻 Places to have a drink\",\n \"color\": \"#0068b3\",\n \"type\": \"prompt\",\n \"data\": \"test\",\n \"fontColor\": \"#ffffff\"\n },\n {\n \"id\": 43,\n \"title\": \"🚋 Public Transportation\",\n \"color\": \"#0068b3\",\n \"type\": \"prompt\",\n \"data\": \"test\",\n \"fontColor\": \"#ffffff\"\n },\n {\n \"id\": 44,\n \"title\": \"🏢 Hotels\",\n \"color\": \"#0068b3\",\n \"type\": \"prompt\",\n \"data\": \"test\",\n \"fontColor\": \"#ffffff\"\n }\n ]\n}"},{"id":"bf562b3d-8868-4681-abad-3165e9adec66","name":"Getting answers","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"projectId\": \"1e6c26e5-26a9-4673-8271-d08e9fb2c2e4\",\r\n \"initial\": false,\r\n \"message\": \"Is there any place for drinking inside the building?\",\r\n \"sessionId\": 1340\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.zetaboto.com/api/v1/chat"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"103"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Sun, 27 Aug 2023 12:43:54 GMT"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"67-5gB3mIOdAapIJnTnKqkCpI28M6Y\""},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 0003b3450f3f9fac44312c4622a410c2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD55-P1"},{"key":"X-Amz-Cf-Id","value":"Zed0nyHVDFY8rtlBmqT_9K8vQNhqrt9vn3epNv2UNX3sZUZzCJRkmQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": \"I'm sorry, but I don't have this information at the moment.\",\n \"messageId\": 309\n}"}],"_postman_id":"a0c166ee-3d62-40e6-87af-e442614cc4b8"},{"name":"Sending Feedback","id":"e830e456-e9d9-40b4-a25e-457e822901c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"feedback\": true // true for positive feedback, false for negative feedback\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.zetaboto.com/api/v1/chat/309/feedback","urlObject":{"protocol":"https","path":["api","v1","chat","309","feedback"],"host":["api","zetaboto","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e830e456-e9d9-40b4-a25e-457e822901c7"},{"name":"Rating Conversation","id":"75a009a1-cf8a-4b50-98e2-dc1f46125c4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"sessionId\": 1340, // session ID\r\n \"rating\": 5 // rating value in range between 1 and 5\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.zetaboto.com/api/v1/chat/rate","urlObject":{"protocol":"https","path":["api","v1","chat","rate"],"host":["api","zetaboto","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"75a009a1-cf8a-4b50-98e2-dc1f46125c4d"},{"name":"Reporting Actions","id":"a6847fe9-458a-40da-a7fd-16650302577a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"sessionId\": 1340, // session ID\r\n \"actionId\": 41, // action ID\r\n \"type\": \"prompt\" // 'prompt' for prompt actions, 'link' for navigation options\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.zetaboto.com/api/v1/chat/action","urlObject":{"protocol":"https","path":["api","v1","chat","action"],"host":["api","zetaboto","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a6847fe9-458a-40da-a7fd-16650302577a"}],"id":"fd5bef0f-6d09-4b6c-bf83-8a18f44b8609","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"e8f41948-83ce-4ebc-a96d-62c760237ea2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5e1f246a-268a-4ea1-aaab-a86cee42ad25","type":"text/javascript","exec":[""]}}],"_postman_id":"fd5bef0f-6d09-4b6c-bf83-8a18f44b8609","description":""},{"name":"Protected APIs","item":[{"name":"Getting Authentication Token","id":"c0558ad7-29b1-4fc6-a640-d49902d013be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"email","value":"john.doe@business.com","description":"Email address
\n","type":"text"},{"key":"password","value":"12345678","description":"Password
\n","type":"text"}]},"url":"https://api.zetaboto.com/api/v1/auth/login","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"10ce9e15-957b-44af-98c1-6c9546d234e5","id":"10ce9e15-957b-44af-98c1-6c9546d234e5","name":"Protected APIs","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","auth","login"],"host":["api","zetaboto","com"],"query":[],"variable":[]}},"response":[{"id":"6050090f-0582-405b-89ec-026ba70b05d3","name":"New Request","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"email","value":"john.doe@business.com","description":"Email address","type":"text"},{"key":"password","value":"12345678","type":"text"}]},"url":"https://api.zetaboto.com/api/v1/auth/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"728"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Sun, 27 Aug 2023 12:58:58 GMT"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"2d8-K7XVdBcWyuUtarHcA0xhxg0C8BI\""},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 5b2c25375d693d0fb882145cde66154e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD55-P1"},{"key":"X-Amz-Cf-Id","value":"k9cNEktyMCZAtPkdHEDA9l2LVrZhWStlQeUxO7pOXjsz56wzJNi-Mw=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"email\": \"john.doe@business.com\",\n \"name\": \"John Doe\",\n \"accessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiZW1haWwiOiJhbGV4LnRheWxvckBwcm9sYWJyZXNlYXJjaC5jb20iLCJpYXQiOjE2OTMxNDExMzgsImV4cCI6MTY5Mzc0NTkzOH0.bMZpoqYEKys3AUVYKzTTOZo-0D24NBFIhd0BX6kIfz4\",\n \"refreshToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiYWNjZXNzVG9rZW4iOiJleUpoYkdjaU9pSklVekkxTmlJc0luUjVjQ0k2SWtwWFZDSjkuZXlKcFpDSTZNU3dpWlcxaGFXd2lPaUpoYkdWNExuUmhlV3h2Y2tCd2NtOXNZV0p5WlhObFlYSmphQzVqYjIwaUxDSnBZWFFpT2pFMk9UTXhOREV4TXpnc0ltVjRjQ0k2TVRZNU16YzBOVGt6T0gwLmJNWnBvcVlFS3lzM0FVVllLelRUT1pvLTBEMjROQkZJaGQwQlg2a0lmejQiLCJpYXQiOjE2OTMxNDExMzgsImV4cCI6MTY5Mzc0NTkzOH0.9UF5b9SQYD0r7v7gP9frBlhxz9XCxRFAXyKvhpJ5Zrw\",\n \"role\": \"user\"\n}"}],"_postman_id":"c0558ad7-29b1-4fc6-a640-d49902d013be"},{"name":"Get Analytics Data","id":"05ae42da-47cd-409e-ac32-8d7e1f220b35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"