"use strict";(self.webpackChunknewoaks_help=self.webpackChunknewoaks_help||[]).push([[6427],{4324:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>l,contentTitle:()=>d,default:()=>u,frontMatter:()=>i,metadata:()=>n,toc:()=>h});const n=JSON.parse('{"id":"api/get-ai-model-list","title":"Get AI Model List","description":"The NewOaks AI API enables the retrieval of knowledge base data for a specified chatbot by sending a GET request to the /chat/Chatbot/ModelList endpoint.","source":"@site/developer/api/103.get-ai-model-list.md","sourceDirName":"api","slug":"/api/get-ai-model-list","permalink":"/guides/developer/api/get-ai-model-list","draft":false,"unlisted":false,"tags":[],"version":"current","sidebarPosition":4,"frontMatter":{"sidebar_position":4},"sidebar":"sidebar","previous":{"title":"Upload a file","permalink":"/guides/developer/api/upload-file"},"next":{"title":"Chatbot","permalink":"/guides/developer/category/chatbot"}}');var r=s(4848),o=s(8453),a=s(767);const i={sidebar_position:4},d="Get AI Model List",l={},h=[{value:"Endpoint",id:"endpoint",level:2},{value:"Request Headers",id:"request-headers",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 c(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:"get-ai-model-list",children:"Get AI Model List"})}),"\n",(0,r.jsxs)(t.p,{children:["The NewOaks AI API enables the retrieval of knowledge base data for a specified chatbot by sending a ",(0,r.jsx)(t.code,{children:"GET"})," request to the ",(0,r.jsx)(t.code,{children:"/chat/Chatbot/ModelList"})," endpoint."]}),"\n",(0,r.jsx)(t.h2,{id:"endpoint",children:"Endpoint"}),"\n",(0,r.jsx)(a.TM,{path:"/chat/Chatbot/ModelList",method:"GET"}),"\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:"example-request",children:"Example Request"}),"\n",(0,r.jsx)(a.r3,{path:"/chat/Chatbot/ModelList",method:"GET",requestBody:{}}),"\n",(0,r.jsx)(t.h2,{id:"response",children:"Response"}),"\n",(0,r.jsx)(a.zV,{responseExample:{Data:[{Key:"2",Value:"gpt-4o",Status:!0},{Key:"3",Value:"gpt-4o-mini",Status:!0},{Key:"22",Value:"claude-3.5-sonnet",Status:!1},{Key:"23",Value:"claude-3.5-haiku",Status:!1}]},responseComments:{Data:"array - List of knowledge items","Data[].Key":"string - AI model ID","Data[].Value":"string - AI model name","Data[].Status":"booleon - AI model availability"}}),"\n",(0,r.jsx)(t.h2,{id:"error-handling",children:"Error Handling"}),"\n",(0,r.jsx)(a.NH,{})]})}function u(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},767:(e,t,s)=>{s.d(t,{Ay:()=>m,NH:()=>p,TM:()=>d,VQ:()=>h,iW:()=>l,r3:()=>c,zV:()=>u});s(6540);var n=s(3532),r=s(8069),o=s(9303),a=s(4848);const i=function(e,t){void 0===t&&(t={});const s=JSON.stringify(e,null,2).split("\n"),n=[];return s.forEach((e=>{const s=e.match(/"([^"]+)":/);if(s&&t[s[1]]){const r=e.match(/^\s*/)?.[0]||"";n.push(`${r}// ${t[s[1]]}`)}n.push(e)})),n.join("\n")},d=e=>{let{path:t,method:s="POST"}=e;const r=(0,n.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:"})," ",s]})]})},l=e=>{let{headers:t={Authorization:"<Your-Secret-Key>","Content-Type":"application/json"},headersDescription:s={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,n]=e;return(0,a.jsxs)("li",{children:[(0,a.jsxs)("code",{children:[t,": ",n]})," - ",s[t]]},t)}))})]})},h=e=>{let{requestBody:t,requestBodyParams:s,addCommentsToJson:n=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:n(t,s)}),(0,a.jsx)("ul",{children:Object.entries(s).map((e=>{let[t,s]=e;return(0,a.jsxs)("li",{children:[(0,a.jsx)("code",{children:t})," - ",s]},t)}))})]})},c=e=>{let{method:t="POST",path:s,requestBody:i,headers:d={Authorization:"<Your-Secret-Key>","Content-Type":"application/json"}}=e;const l=(0,n.r)()(s),h="undefined"==typeof window?"usapi.hottask.com":new URL(l||`https://usapi.hottask.com${s}`).host,c={javascript:`const res = await fetch('${l||`https://usapi.hottask.com${s}`}', {\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 = '${l||`https://usapi.hottask.com${s}`}'\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 '${l||`https://usapi.hottask.com${s}`}' \\\n  -X ${t} \\\n${Object.entries(d).map((e=>{let[t,s]=e;return`  -H '${t}: ${s}' \\`})).join("\n")}\n  -d '${JSON.stringify(i)}'`,http:`${t} ${s} HTTP/1.1\nHost: ${h}\n${Object.entries(d).map((e=>{let[t,s]=e;return`${t}: ${s}`})).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:c.javascript}),(0,a.jsx)(o.A,{as:"h3",children:"Python (Requests Library)"}),(0,a.jsx)(r.A,{language:"python",children:c.python}),(0,a.jsx)(o.A,{as:"h3",children:"cURL"}),(0,a.jsx)(r.A,{language:"bash",children:c.bash}),(0,a.jsx)(o.A,{as:"h3",children:"HTTP Request"}),(0,a.jsx)(r.A,{language:"http",children:c.http})]})},u=e=>{let{responseExample:t,responseComments:s,addCommentsToJson:n=i}=e;const o={...t,Version:"1.0.0",Success:!0,Code:200,Message:""},d={...s,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:n(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:s,method:r="POST",description:o="",requestBody:m={timeZone:"Asia/Shanghai",type:0},requestBodyDescription:g={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:j={timeZone:"string, required",type:"integer, required"},responseExample:x={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 T=(0,n.r)()(s),$="undefined"==typeof window?"usapi.hottask.com":new URL(T||`https://usapi.hottask.com${s}`).host;JSON.stringify(y,null,2),i(m,j),JSON.stringify(y,null,4),i(m,j),r.toLowerCase(),Object.entries(y).map((e=>{let[t,s]=e;return`  -H '${t}: ${s}' \\`})).join("\n"),JSON.stringify(m),Object.entries(y).map((e=>{let[t,s]=e;return`${t}: ${s}`})).join("\n"),i(m,j);return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(d,{path:s,method:r}),(0,a.jsx)(l,{headers:y,headersDescription:b}),(0,a.jsx)(h,{requestBody:m,requestBodyParams:g,addCommentsToJson:i}),(0,a.jsx)(c,{method:r,path:s,requestBody:m,headers:y}),(0,a.jsx)(u,{responseExample:x,responseComments:f,addCommentsToJson:i}),(0,a.jsx)(p,{errorHandling:w})]})}},3532:(e,t,s)=>{function n(){return function(e){if("undefined"==typeof window)return"";const t=window.location.hostname;let s="";return s="www.newoaks.ai"==t||"newoaks.ai"==t?"https://usapi.hottask.com":"eu.newoaks.ai"==t?"https://euapi.hottask.com":`https://${t}`,e?`${s}${e.startsWith("/")?e:`/${e}`}`:s}}s.d(t,{r:()=>n})}}]);