"use strict";(self.webpackChunknewoaks_help=self.webpackChunknewoaks_help||[]).push([[134],{3689:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>h,default:()=>p,frontMatter:()=>d,metadata:()=>s,toc:()=>l});const s=JSON.parse('{"id":"api/chatbot/create-a-chatbot","title":"Create a chatbot","description":"The  Creation API provides functionality to create a new chatbot by sending a POST request to the /chat/Chatbot/Add endpoint.","source":"@site/developer/api/002.chatbot/101.create-a-chatbot.md","sourceDirName":"api/002.chatbot","slug":"/api/chatbot/create-a-chatbot","permalink":"/guides/developer/api/chatbot/create-a-chatbot","draft":false,"unlisted":false,"tags":[],"version":"current","sidebarPosition":101,"frontMatter":{"sidebar_position":101},"sidebar":"sidebar","previous":{"title":"Chatbot","permalink":"/guides/developer/category/chatbot"},"next":{"title":"Edit Chatbot Settings","permalink":"/guides/developer/api/chatbot/edit-chatbot"}}');var r=n(4848),o=n(8453),a=n(767),i=(n(9357),n(8175));const d={sidebar_position:101},h="Create a chatbot",c={},l=[{value:"Endpoint",id:"endpoint",level:2},{value:"Request Headers",id:"request-headers",level:2},{value:"Request Body",id:"request-body",level:2},{value:"Example Request",id:"example-request",level:2},{value:"Response",id:"response",level:2},{value:"Error Handling",id:"error-handling",level:2}];function u(e){const t={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"create-a-chatbot",children:"Create a chatbot"})}),"\n",(0,r.jsxs)(t.p,{children:["The ",(0,r.jsx)(i.A,{})," Creation API provides functionality to create a new chatbot by sending a ",(0,r.jsx)(t.code,{children:"POST"})," request to the ",(0,r.jsx)(t.code,{children:"/chat/Chatbot/Add"})," endpoint."]}),"\n",(0,r.jsx)(t.h2,{id:"endpoint",children:"Endpoint"}),"\n",(0,r.jsx)(a.TM,{path:"/chat/Chatbot/Add"}),"\n",(0,r.jsx)(t.h2,{id:"request-headers",children:"Request Headers"}),"\n",(0,r.jsx)(a.iW,{}),"\n",(0,r.jsx)(t.h2,{id:"request-body",children:"Request Body"}),"\n",(0,r.jsx)(a.VQ,{requestBody:{timeZone:"Asia/Shanghai",type:0},requestBodyParams:{timeZone:"string, required - The time zone of the chatbot (e.g., Asia/Shanghai, America/New_York)",type:"integer, required - Must be 0 for generic chatbot"}}),"\n",(0,r.jsx)(t.h2,{id:"example-request",children:"Example Request"}),"\n",(0,r.jsx)(a.r3,{method:"POST",path:"/chat/Chatbot/Add",requestBody:{timeZone:"Asia/Shanghai",type:0}}),"\n",(0,r.jsx)(t.h2,{id:"response",children:"Response"}),"\n",(0,r.jsx)(a.zV,{responseExample:{Data:"3254a9d0424c4806b9ea3d0763xxxxxx"},responseComments:{Data:"string - The unique identifier (ID) of the created chatbot"}}),"\n",(0,r.jsx)(t.h2,{id:"error-handling",children:"Error Handling"}),"\n",(0,r.jsx)(a.NH,{})]})}function p(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},767:(e,t,n)=>{n.d(t,{Ay:()=>m,NH:()=>p,TM:()=>d,VQ:()=>c,iW:()=>h,r3:()=>l,zV:()=>u});n(6540);var s=n(3532),r=n(8069),o=n(9303),a=n(4848);const i=function(e,t){void 0===t&&(t={});const n=JSON.stringify(e,null,2).split("\n"),s=[];return n.forEach((e=>{const n=e.match(/"([^"]+)":/);if(n&&t[n[1]]){const r=e.match(/^\s*/)?.[0]||"";s.push(`${r}// ${t[n[1]]}`)}s.push(e)})),s.join("\n")},d=e=>{let{path:t,method:n="POST"}=e;const r=(0,s.r)()(t)||`https://usapi.hottask.com${t}`;return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsxs)("p",{children:[(0,a.jsx)("strong",{children:"Request URL:"})," ",r]}),(0,a.jsxs)("p",{children:[(0,a.jsx)("strong",{children:"Method:"})," ",n]})]})},h=e=>{let{headers:t={Authorization:"<Your-Secret-Key>","Content-Type":"application/json"},headersDescription:n={Authorization:"string, required - The secret key for authenticating the API request","Content-Type":"string, required - The content type of the request payload (must be application/json)"}}=e;return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("p",{children:"The API request must include the following headers:"}),(0,a.jsx)("ul",{children:Object.entries(t).map((e=>{let[t,s]=e;return(0,a.jsxs)("li",{children:[(0,a.jsxs)("code",{children:[t,": ",s]})," - ",n[t]]},t)}))})]})},c=e=>{let{requestBody:t,requestBodyParams:n,addCommentsToJson:s=i}=e;return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("p",{children:"The request body should contain the following parameters:"}),(0,a.jsx)(r.A,{language:"json",children:s(t,n)}),(0,a.jsx)("ul",{children:Object.entries(n).map((e=>{let[t,n]=e;return(0,a.jsxs)("li",{children:[(0,a.jsx)("code",{children:t})," - ",n]},t)}))})]})},l=e=>{let{method:t="POST",path:n,requestBody:i,headers:d={Authorization:"<Your-Secret-Key>","Content-Type":"application/json"}}=e;const h=(0,s.r)()(n),c="undefined"==typeof window?"usapi.hottask.com":new URL(h||`https://usapi.hottask.com${n}`).host,l={javascript:`const res = await fetch('${h||`https://usapi.hottask.com${n}`}', {\n  method: '${t}',\n  headers: ${JSON.stringify(d,null,2)},\n  body: JSON.stringify(${JSON.stringify(i,null,2)})\n});\n\nconst data = await res.json();\nconsole.log(data);`,python:`import requests\nimport json\n\nurl = '${h||`https://usapi.hottask.com${n}`}'\nheaders = ${JSON.stringify(d,null,4)}\ndata = ${JSON.stringify(i,null,2)}\n\nresponse = requests.${t.toLowerCase()}(url, headers=headers, json=data)\ndata = response.json()\nprint(data)`,bash:`curl '${h||`https://usapi.hottask.com${n}`}' \\\n  -X ${t} \\\n${Object.entries(d).map((e=>{let[t,n]=e;return`  -H '${t}: ${n}' \\`})).join("\n")}\n  -d '${JSON.stringify(i)}'`,http:`${t} ${n} HTTP/1.1\nHost: ${c}\n${Object.entries(d).map((e=>{let[t,n]=e;return`${t}: ${n}`})).join("\n")}\n\n${JSON.stringify(i,null,2)}`};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(o.A,{as:"h3",children:"JavaScript (Fetch API)"}),(0,a.jsx)(r.A,{language:"javascript",children:l.javascript}),(0,a.jsx)(o.A,{as:"h3",children:"Python (Requests Library)"}),(0,a.jsx)(r.A,{language:"python",children:l.python}),(0,a.jsx)(o.A,{as:"h3",children:"cURL"}),(0,a.jsx)(r.A,{language:"bash",children:l.bash}),(0,a.jsx)(o.A,{as:"h3",children:"HTTP Request"}),(0,a.jsx)(r.A,{language:"http",children:l.http})]})},u=e=>{let{responseExample:t,responseComments:n,addCommentsToJson:s=i}=e;const o={...t,Version:"1.0.0",Success:!0,Code:200,Message:""},d={...n,Version:"string - API version",Success:"boolean - Operation success status",Code:"integer - HTTP status code",Message:"string - Error message if any"};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("p",{children:"The API response will be a JSON object with the following structure:"}),(0,a.jsx)(r.A,{language:"json",children:s(o,d)})]})},p=e=>{let{errorHandling:t="If the request fails, you should:\n1. Check the HTTP status code for network-level errors\n2. Examine the `Code` and `Message` fields in the response for business-level errors\n3. The `Message` field will contain detailed error information"}=e;return(0,a.jsx)("div",{style:{whiteSpace:"pre-line"},children:t})};function m(e){let{title:t,path:n,method:r="POST",description:o="",requestBody:m={timeZone:"Asia/Shanghai",type:0},requestBodyDescription:j={timeZone:"The time zone of the chatbot. The standard time zone format: e.g., Asia/Shanghai or America/New_York.",type:"Create a generic chatbot with a fixed value of 0"},requestBodyComments:x={timeZone:"string, required",type:"integer, required"},responseExample:g={Data:"3254a9d0424c4806b9ea3d0763xxxxxx",Version:"1.0.0",Success:!0,Code:200,Message:""},responseComments:f={Data:"chatbot id"},headers:y={Authorization:"<Your-Secret-Key>","Content-Type":"application/json"},headersDescription:b={Authorization:"The secret key for authenticating the API request.","Content-Type":"The content type of the request payload."},errorHandling:w="If it's an HTTP network error, you should check the `HTTP status code`. If it's a business exception, you need to examine the `Code` and `Message` fields, which will provide the error details."}=e;const q=(0,s.r)()(n),T="undefined"==typeof window?"usapi.hottask.com":new URL(q||`https://usapi.hottask.com${n}`).host;JSON.stringify(y,null,2),i(m,x),JSON.stringify(y,null,4),i(m,x),r.toLowerCase(),Object.entries(y).map((e=>{let[t,n]=e;return`  -H '${t}: ${n}' \\`})).join("\n"),JSON.stringify(m),Object.entries(y).map((e=>{let[t,n]=e;return`${t}: ${n}`})).join("\n"),i(m,x);return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(d,{path:n,method:r}),(0,a.jsx)(h,{headers:y,headersDescription:b}),(0,a.jsx)(c,{requestBody:m,requestBodyParams:j,addCommentsToJson:i}),(0,a.jsx)(l,{method:r,path:n,requestBody:m,headers:y}),(0,a.jsx)(u,{responseExample:g,responseComments:f,addCommentsToJson:i}),(0,a.jsx)(p,{errorHandling:w})]})}},8175:(e,t,n)=>{n.d(t,{A:()=>o});n(6540);var s=n(5872),r=n(4848);function o(){let e=(0,s.K)()();return["newoaks.ai","www.newoaks.ai","eu.newoaks.ai"].includes(e)&&(e="NewOaks AI"),"appointify.ai"===e&&(e="Appointify AI"),(0,r.jsx)("code",{children:e})}},9357:(e,t,n)=>{n.d(t,{A:()=>a});n(6540);var s=n(5872),r=n(5363),o=n(4848);function a(e){let{children:t}=e;return(0,o.jsx)(r.A,{children:()=>{const e=(0,s.K)()();if("function"==typeof t){const n=t(e);return(0,o.jsx)("div",{className:"markdown markdown--section",children:n})}return(0,o.jsx)("code",{children:e})}})}},3532:(e,t,n)=>{function s(){return function(e){if("undefined"==typeof window)return"";const t=window.location.hostname;let n="";return n="www.newoaks.ai"==t||"newoaks.ai"==t?"https://usapi.hottask.com":"eu.newoaks.ai"==t?"https://euapi.hottask.com":`https://${t}`,e?`${n}${e.startsWith("/")?e:`/${e}`}`:n}}n.d(t,{r:()=>s})},5872:(e,t,n)=>{function s(){return function(){return"undefined"==typeof window?"":window.location.hostname}}n.d(t,{K:()=>s})}}]);