[{"_1":2,"_745":-5,"_746":-5},"loaderData",{"_3":4,"_744":-5},"root",{"_5":1,"_6":7,"_31":32,"_35":-7,"_36":37,"_56":57,"_140":141,"_186":187,"_740":741},"type","meta",[8,15,18,21,26,29],{"_9":10,"_11":12,"_13":14},"tagName","link","rel","icon","href","https://cdn.apifox.com/app/apidoc-image/custom/20260701/3a2b43ce-ed96-44cc-a03c-2f8ecb0258bd.png",{"_9":10,"_11":12,"_13":14,"_16":17},"media","(prefers-color-scheme: dark)",{"_9":10,"_11":19,"_13":20},"canonical","https://doc.nexhina.ai/9095218m0",{"_22":23,"_24":25},"name","description","content","Getting an API Key - Nexhina ",{"_22":27,"_24":28},"keywords","Getting an API Key, Nexhina , API Design, API Specification, API Test, API Documentation, API Mock",{"_30":25},"title","i18nState",{"_33":34},"clientLocale","en-US","errorCodeMessage","clientConfig",{"_38":39,"_40":41,"_42":43,"_44":45,"_50":51,"_52":53,"_54":55},"apiBaseUrl","https://api.apifox.cn","appWebUrl","https://app.apifox.com","apidocBuiltinPrefixPath","https://cdn.apifox.com/app/static/apidoc","cloudMockBaseUrls",{"_46":47,"_48":49},"pathMode","https://m1.apifoxmock.com/m1/{projectId}-{version}-{service}","idMode","https://m1.apifoxmock.com/m2/{projectId}-{version}-{service}","apidocIsShowLogo",true,"markdownDisableBreaks",false,"webhookGenerateCodeDefaultUrl","https://your-api-server.com","urlConfig",{"_58":59,"_12":62,"_127":128,"_136":137},"home",{"_60":61},"index","https://apifox.com",{"_63":64,"_65":66,"_67":68,"_69":70,"_71":72,"_73":74,"_75":76,"_77":78,"_79":80,"_81":82,"_83":84,"_85":86,"_87":88,"_89":90,"_91":92,"_93":94,"_95":96,"_97":98,"_99":100,"_101":102,"_103":104,"_105":106,"_107":108,"_109":110,"_111":112,"_113":114,"_115":116,"_117":118,"_119":120,"_121":122,"_123":124,"_125":126},"apidoc","https://cdn.apifox.com/app/static/brand/apidoc.png","apifox","https://cdn.apifox.com/app/static/brand/apifox.png","apipost","https://cdn.apifox.com/app/static/brand/apipost.png","apizza","https://cdn.apifox.com/app/static/brand/apizza.png","doclever","https://cdn.apifox.com/app/static/brand/doclever.png","docway","https://cdn.apifox.com/app/static/brand/docway.png","easydoc","https://cdn.apifox.com/app/static/brand/easydoc.png","eolink","https://cdn.apifox.com/app/static/brand/eolink.png","googleDiscovery","https://cdn.apifox.com/app/static/brand/google-discovery.png","har","https://cdn.apifox.com/app/static/brand/har.png","iodocs","https://cdn.apifox.com/app/static/brand/io-doc.png","jmeter","https://cdn.apifox.com/app/static/brand/jmeter.png","knife4j","https://cdn.apifox.com/app/static/brand/knife4j.png","nei","https://cdn.apifox.com/app/static/brand/nei.png","openapi","https://cdn.apifox.com/app/static/brand/openapi.png","postman","https://cdn.apifox.com/app/static/brand/postman.png","raml","https://cdn.apifox.com/app/static/brand/raml.png","rap2","https://cdn.apifox.com/app/static/brand/rap2.png","showdoc","https://cdn.apifox.com/app/static/brand/showdoc.png","sosoapi","https://cdn.apifox.com/app/static/brand/sosoapi.png","wadl","https://cdn.apifox.com/app/static/brand/wadl.png","yapi","https://cdn.apifox.com/app/static/brand/yapi.png","curl","https://cdn.apifox.com/app/static/brand/curl.png","insomnia","https://cdn.apifox.com/app/static/brand/insomnia.png","wsdl","https://cdn.apifox.com/app/static/brand/wsdl.png","markdown","https://cdn.apifox.com/app/static/brand/markdown.png","html","https://cdn.apifox.com/app/static/brand/html.png","protobuf","https://cdn.apifox.com/app/static/brand/protobuf.png","javaProject","https://cdn.apifox.com/app/static/brand/java-project.png","xiaoyaoji","https://cdn.apifox.com/app/static/brand/xiaoyaoji.png","soapui","https://cdn.apifox.com/app/static/brand/soapui.svg","hoppscotch","https://cdn.apifox.com/app/static/brand/hoppscotch.svg","help",{"_60":129,"_130":131,"_132":133,"_134":135},"https://apifox.com/help","browserExtension","https://apifox.com/help/applications-and-plugins/browser-extensions/chrome","csv","https://apifox.com/help/reference/csv","appMcpServer","https://docs.apifox.com/apifox-mcp-server","assets",{"_138":139},"logo512Png","https://cdn.apifox.com/logo/apifox-logo-512.png","envConfig",{"_142":63,"_143":144,"_145":144,"_146":147,"_148":149,"_150":151,"_152":61,"_153":65,"_154":155,"_156":157,"_158":159,"_162":144,"_163":164,"_165":166,"_167":168,"_169":170,"_171":172,"_180":181,"_182":51,"_183":184,"_185":53},"RELEASE_BASE","DEBUG_API_BASE","","DEBUG_WEB_URL_BASE","AGENT_SERVER_API_BASE","https://web-proxy.apifox.com","APP_REGION","CN","APP_NAME","Apifox","APP_HOMEPAGE","APP_NAME_LOWER","DEFAULT_LOCALE","zh-CN","APP_BROWSER_EXTENSION_ADAPTER","foxAgentCrossRequest","APP_API_SERVER_HOSTNAMES",[160,161],"api.apifox.com","api.apifox.cn","APP_SUPPORT_EMAIL","APP_SCRIPT_MAIN_OBJECTS","$,fox","SERVER_PROTOCOL","http","SERVER_HOST","apifox-api-fordoc-svc","DEFAULT_DOC_LAYOUT","OneColumn","NOT_CUSTOM_DOMAIN_HOSTNAMES",[173,174,175,176,177,178,179],"www.apifox.com","apifox.com","www.apifox.cn","apifox.cn","share.apifox.cn","s.apifox.cn","127.0.0.1","SERVER_REQUEST_TIMEOUT",100000,"IS_SHARED_DOC_INDEPENDENT_DOMAIN","APIDOC_CUSTOM_DOMAIN_CNAME_REGEX",["R","\\d+\\.n[12x]\\.apifox\\.cn",""],"IS_ALWAYS_USE_ORIGIN_FETCH","docsDataState",{"_188":189,"_197":198,"_485":486,"_607":608,"_613":614,"_646":647,"_660":661,"_662":663,"_664":665,"_705":706,"_714":715,"_716":717,"_725":726,"_727":728,"_732":733,"_735":736},"navigation",{"_5":190,"_191":192},"NONE","navRightLinkItems",[193],{"_5":194,"_195":196},"modeSwitch","key","mode-switch","sidebarTree",{"_199":-7,"_200":-7,"_201":202,"_203":204,"_475":476,"_477":478,"_481":482,"_483":484},"goBackSidebarTreeApiFolderNode","rootSidebarTreeApiFolderNode","homeLink","/","sidebarTreeList",[205,250,292,451],{"_5":206,"_207":208,"_209":210,"_22":211,"_195":212,"_213":214,"_219":-7,"_220":221,"_227":208,"_228":-7,"_23":-7,"_246":206,"_247":248,"_12":-7,"_231":144,"_233":53,"_249":53},"apiDetailFolder","docId",0,"id",89715391,"Start","apiDetailFolder.89715391","shareSettings",{"_215":216,"_217":218},"directoryTreeDisplayStyle","GENERAL_FOLDER","folderContentsDisplayingSettings","HIDE","linkedUri","children",[222,234,240],{"_5":223,"_209":224,"_22":225,"_195":226,"_227":210,"_228":-7,"_229":230,"_12":-7,"_231":232,"_233":53},"doc",9095210,"Product Intrduction","doc.9095210","parentId","resourceName","tags",[],"to","/9095210m0","selected",{"_5":223,"_209":235,"_22":236,"_195":237,"_227":210,"_228":-7,"_229":238,"_12":-7,"_231":239,"_233":53},9095211,"Quick to use","doc.9095211",[],"/9095211m0",{"_5":223,"_209":241,"_22":242,"_195":243,"_227":210,"_228":-7,"_229":244,"_12":-7,"_231":245,"_233":53},9095212,"Using Nexhina in AI Coding Tools","doc.9095212",[],"/9095212m0","folderType","moduleId",8086847,"expanded",{"_5":206,"_207":208,"_209":251,"_22":252,"_195":253,"_213":254,"_219":-7,"_220":255,"_227":208,"_228":-7,"_23":-7,"_246":206,"_247":248,"_12":-7,"_231":144,"_233":53,"_249":51},89715636,"API integration explanation","apiDetailFolder.89715636",{"_215":216,"_217":218},[256,262,268,274,280,286],{"_5":223,"_209":257,"_22":258,"_195":259,"_227":251,"_228":-7,"_229":260,"_12":-7,"_231":261,"_233":53},9095220,"Quick Start","doc.9095220",[],"/9095220m0",{"_5":223,"_209":263,"_22":264,"_195":265,"_227":251,"_228":-7,"_229":266,"_12":-7,"_231":267,"_233":51},9095218,"Getting an API Key","doc.9095218",[],"/9095218m0",{"_5":223,"_209":269,"_22":270,"_195":271,"_227":251,"_228":-7,"_229":272,"_12":-7,"_231":273,"_233":53},9095219,"Authentication","doc.9095219",[],"/9095219m0",{"_5":223,"_209":275,"_22":276,"_195":277,"_227":251,"_228":-7,"_229":278,"_12":-7,"_231":279,"_233":53},9095222,"Request URL","doc.9095222",[],"/9095222m0",{"_5":223,"_209":281,"_22":282,"_195":283,"_227":251,"_228":-7,"_229":284,"_12":-7,"_231":285,"_233":53},9095217,"HTTP Status Codes","doc.9095217",[],"/9095217m0",{"_5":223,"_209":287,"_22":288,"_195":289,"_227":251,"_228":-7,"_229":290,"_12":-7,"_231":291,"_233":53},9095221,"Streaming Output Guide","doc.9095221",[],"/9095221m0",{"_5":206,"_207":208,"_209":293,"_22":294,"_195":295,"_213":296,"_219":-7,"_220":297,"_227":208,"_228":-7,"_23":-7,"_246":206,"_247":248,"_12":-7,"_231":144,"_233":53,"_249":53},89607056,"API Endpoints","apiDetailFolder.89607056",{"_215":216,"_217":218},[298,319,334,348,362,382,410,424,438],{"_5":206,"_207":208,"_209":299,"_22":300,"_195":301,"_213":302,"_219":-7,"_220":303,"_227":293,"_228":-7,"_23":-7,"_246":206,"_247":248,"_12":-7,"_231":144,"_233":53,"_249":53},89607057,"Chat","apiDetailFolder.89607057",{"_215":216,"_217":218},[304],{"_5":305,"_209":306,"_22":307,"_195":308,"_309":310,"_311":312,"_313":314,"_227":299,"_228":-7,"_229":315,"_23":-7,"_317":166,"_12":-7,"_231":318,"_233":53},"apiDetail",479755252,"Chat Completion","apiDetail.479755252","method","post","path","/v1/chat/completions","status","released",[316,300],"API Endpoints/Chat","apiType","/479755252e0",{"_5":206,"_207":208,"_209":320,"_22":321,"_195":322,"_213":323,"_219":-7,"_220":324,"_227":293,"_228":-7,"_23":-7,"_246":206,"_247":248,"_12":-7,"_231":144,"_233":53,"_249":53},89607058,"Models","apiDetailFolder.89607058",{"_215":216,"_217":218},[325],{"_5":305,"_209":326,"_22":327,"_195":328,"_309":329,"_311":330,"_313":314,"_227":320,"_228":-7,"_229":331,"_23":-7,"_317":166,"_12":-7,"_231":333,"_233":53},479755253,"List Available Models","apiDetail.479755253","get","/v1/models",[332,321],"API Endpoints/Models","/479755253e0",{"_5":206,"_207":208,"_209":335,"_22":336,"_195":337,"_213":338,"_219":-7,"_220":339,"_227":293,"_228":-7,"_23":-7,"_246":206,"_247":248,"_12":-7,"_231":144,"_233":53,"_249":53},89607059,"Responses","apiDetailFolder.89607059",{"_215":216,"_217":218},[340],{"_5":305,"_209":341,"_22":342,"_195":343,"_309":310,"_311":344,"_313":314,"_227":335,"_228":-7,"_229":345,"_23":-7,"_317":166,"_12":-7,"_231":347,"_233":53},479755254,"Responses API","apiDetail.479755254","/v1/responses",[346,336],"API Endpoints/Responses","/479755254e0",{"_5":206,"_207":208,"_209":349,"_22":350,"_195":351,"_213":352,"_219":-7,"_220":353,"_227":293,"_228":-7,"_23":-7,"_246":206,"_247":248,"_12":-7,"_231":144,"_233":53,"_249":53},89607060,"Embeddings","apiDetailFolder.89607060",{"_215":216,"_217":218},[354],{"_5":305,"_209":355,"_22":356,"_195":357,"_309":310,"_311":358,"_313":314,"_227":349,"_228":-7,"_229":359,"_23":-7,"_317":166,"_12":-7,"_231":361,"_233":53},479755255,"Text Embedding","apiDetail.479755255","/v1/embeddings",[360,350],"API Endpoints/Embeddings","/479755255e0",{"_5":206,"_207":208,"_209":363,"_22":364,"_195":365,"_213":366,"_219":-7,"_220":367,"_227":293,"_228":-7,"_23":-7,"_246":206,"_247":248,"_12":-7,"_231":144,"_233":53,"_249":53},89607061,"Images","apiDetailFolder.89607061",{"_215":216,"_217":218},[368,375],{"_5":305,"_209":369,"_22":370,"_195":371,"_309":310,"_311":372,"_313":314,"_227":363,"_228":-7,"_229":373,"_23":-7,"_317":166,"_12":-7,"_231":374,"_233":53},479755256,"Text-to-Image","apiDetail.479755256","/v1/images/generations",[364],"/479755256e0",{"_5":305,"_209":376,"_22":377,"_195":378,"_309":310,"_311":379,"_313":314,"_227":363,"_228":-7,"_229":380,"_23":-7,"_317":166,"_12":-7,"_231":381,"_233":53},503410737,"Image-to-Image","apiDetail.503410737","/v1/images/edits",[364],"/503410737e0",{"_5":206,"_207":208,"_209":383,"_22":384,"_195":385,"_213":386,"_219":-7,"_220":387,"_227":293,"_228":-7,"_23":-7,"_246":206,"_247":248,"_12":-7,"_231":144,"_233":53,"_249":53},89607062,"Audio","apiDetailFolder.89607062",{"_215":216,"_217":218},[388,396,403],{"_5":305,"_209":389,"_22":390,"_195":391,"_309":310,"_311":392,"_313":314,"_227":383,"_228":-7,"_229":393,"_23":-7,"_317":166,"_12":-7,"_231":395,"_233":53},479755257,"Text-to-Speech (TTS)","apiDetail.479755257","/v1/audio/speech",[394,384],"API Endpoints/Audio","/479755257e0",{"_5":305,"_209":397,"_22":398,"_195":399,"_309":310,"_311":400,"_313":314,"_227":383,"_228":-7,"_229":401,"_23":-7,"_317":166,"_12":-7,"_231":402,"_233":53},479755258,"Speech-to-Text (STT)","apiDetail.479755258","/v1/audio/transcriptions",[394,384],"/479755258e0",{"_5":305,"_209":404,"_22":405,"_195":406,"_309":310,"_311":407,"_313":314,"_227":383,"_228":-7,"_229":408,"_23":-7,"_317":166,"_12":-7,"_231":409,"_233":53},479755259,"Audio Translation","apiDetail.479755259","/v1/audio/translations",[394,384],"/479755259e0",{"_5":206,"_207":208,"_209":411,"_22":412,"_195":413,"_213":414,"_219":-7,"_220":415,"_227":293,"_228":-7,"_23":-7,"_246":206,"_247":248,"_12":-7,"_231":144,"_233":53,"_249":53},89607063,"Video","apiDetailFolder.89607063",{"_215":216,"_217":218},[416],{"_5":305,"_209":417,"_22":418,"_195":419,"_309":310,"_311":420,"_313":314,"_227":411,"_228":-7,"_229":421,"_23":-7,"_317":166,"_12":-7,"_231":423,"_233":53},479755260,"Generate Video","apiDetail.479755260","/v1/video/generations",[422,412],"API Endpoints/Video","/479755260e0",{"_5":206,"_207":208,"_209":425,"_22":426,"_195":427,"_213":428,"_219":-7,"_220":429,"_227":293,"_228":-7,"_23":-7,"_246":206,"_247":248,"_12":-7,"_231":144,"_233":53,"_249":53},89607064,"Moderation","apiDetailFolder.89607064",{"_215":216,"_217":218},[430],{"_5":305,"_209":431,"_22":432,"_195":433,"_309":310,"_311":434,"_313":314,"_227":425,"_228":-7,"_229":435,"_23":-7,"_317":166,"_12":-7,"_231":437,"_233":53},479755261,"Content Moderation","apiDetail.479755261","/v1/moderations",[436,426],"API Endpoints/Moderation","/479755261e0",{"_5":206,"_207":208,"_209":439,"_22":440,"_195":441,"_213":442,"_219":-7,"_220":443,"_227":293,"_228":-7,"_23":-7,"_246":206,"_247":248,"_12":-7,"_231":144,"_233":53,"_249":53},89607065,"Rerank","apiDetailFolder.89607065",{"_215":216,"_217":218},[444],{"_5":305,"_209":445,"_22":440,"_195":446,"_309":310,"_311":447,"_313":314,"_227":439,"_228":-7,"_229":448,"_23":-7,"_317":166,"_12":-7,"_231":450,"_233":53},479755262,"apiDetail.479755262","/v1/rerank",[449,440],"API Endpoints/Rerank","/479755262e0",{"_5":206,"_207":208,"_209":452,"_22":453,"_195":454,"_213":455,"_219":-7,"_220":456,"_227":208,"_228":-7,"_23":-7,"_246":206,"_247":248,"_12":-7,"_231":144,"_233":53,"_249":53},89715667,"Platform-related","apiDetailFolder.89715667",{"_215":216,"_217":218},[457,463,469],{"_5":223,"_209":458,"_22":459,"_195":460,"_227":452,"_228":-7,"_229":461,"_12":-7,"_231":462,"_233":53},9095214,"Platform agreement","doc.9095214",[],"/9095214m0",{"_5":223,"_209":464,"_22":465,"_195":466,"_227":452,"_228":-7,"_229":467,"_12":-7,"_231":468,"_233":53},9095215,"Privacy Policy","doc.9095215",[],"/9095215m0",{"_5":223,"_209":470,"_22":471,"_195":472,"_227":452,"_228":-7,"_229":473,"_12":-7,"_231":474,"_233":53},9095213,"General Questions","doc.9095213",[],"/9095213m0","selectedSidebarTreeNode",{"_5":223,"_209":263,"_22":264,"_195":265,"_227":251,"_228":-7,"_229":266,"_12":-7,"_231":267,"_233":51},"parentSidebarTreeApiFolderNodes",[479],{"_5":206,"_207":208,"_209":251,"_22":252,"_195":253,"_213":254,"_219":-7,"_220":480,"_227":208,"_228":-7,"_23":-7,"_246":206,"_247":248,"_12":-7,"_231":144,"_233":53,"_249":51},[],"previousSidebarTreeNode",{"_5":223,"_209":257,"_22":258,"_195":259,"_227":251,"_228":-7,"_229":260,"_12":-7,"_231":261,"_233":53},"nextSidebarTreeNode",{"_5":223,"_209":269,"_22":270,"_195":271,"_227":251,"_228":-7,"_229":272,"_12":-7,"_231":273,"_233":53},"docsBaseConfig",{"_30":487,"_488":487,"_23":144,"_489":490,"_500":14,"_501":14,"_502":503,"_515":34,"_516":491,"_517":53,"_518":53,"_519":53,"_520":53,"_521":53,"_522":51,"_523":524,"_526":53,"_527":53,"_528":51,"_529":53,"_530":51,"_531":53,"_532":53,"_533":53,"_534":535,"_537":538,"_544":170,"_545":546,"_550":551,"_553":53,"_554":51,"_555":51,"_556":557,"_558":559,"_562":51,"_563":51,"_564":53,"_565":51,"_566":51,"_567":-7,"_568":-7,"_569":570,"_589":590,"_591":592,"_593":594},"Nexhina ","siteName","logoSettings",{"_491":492,"_497":498},"light",{"_5":493,"_12":494,"_495":496,"_30":144},"custom","https://cdn.apifox.com/app/apidoc-image/custom/20260701/97b4dee6-878c-40c5-8a45-56d944c402a3.png","radius","m","dark",{"_5":499,"_12":494,"_495":496,"_30":144},"followLight","favicon","faviconDark","themePrimarySettings",{"_491":504,"_497":513},{"_505":506,"_507":508,"_509":510,"_511":512},"primaryColor","rgba(126,87,237,1)","textColor","WHITE","backgroundColor","#ffffff","accentColor","purple",{"_505":506,"_507":508,"_509":514,"_511":512},"rgb(255, 255, 255)","language","theme","displayThemeToggle","isShowPrefixUrl","isShowMaintainer","isShowTags","isShowUpdatedAt","isShowLastModifiedAt","displayFieldIds",[525],"api.label.sampleCode","hidePoweredBy","hideBuiltWith","hideRunInAppButton","hideTryItOutButton","exportable","hideCloneButton","hideMyAppButton","hideAppFormatExportOption","googleAnalytics",{"_536":144},"measurementId","visibilitySettings",{"_5":539,"_540":541},"PUBLIC","advancedSettings",{"_542":543},"emailSettings",{},"apiDocLayout","mockRule",{"_547":548,"_549":51},"rules",[],"enableSystemRule","corsProxySettings",{"_209":552},4,"enableVibeCodingViaMCP","enableCopyPage","enableLLMs","globalMetadata","[\n {\"name\": \"description\", \"content\": \"{{DESCRIPTION}}\"},\n {\"name\": \"keywords\", \"content\": \"{{KEYWORDS}}\"}\n]","robotsFile",{"_560":51,"_24":561},"enable","User-Agent: *\nAllow: /\n\nSitemap: {{SITEMAP_URL}}","enableSitemapFile","persistEnvVariables","showDataSchemas","showDataSchemasExample","showDataSchemasAutoGenerateExample","landingPageType","folderTreeWidth","backgroundImageSettings",{"_491":571,"_497":587},{"_572":573,"_574":575,"_576":577,"_578":579,"_580":575,"_581":582,"_583":584,"_585":582,"_586":144,"_5":582},"size","cover","scale",100,"position","center","fixed","scroll","opacity","colorType","default","color","#039e74","backgroundImageType","backgroundImage",{"_572":573,"_574":575,"_576":577,"_578":579,"_580":575,"_581":582,"_583":588,"_585":582,"_586":582,"_5":582},"#9373EE","overallLayout","upDown","searchPosition","navRight","navMenuSettings",{"_595":596,"_597":598,"_599":600,"_601":53,"_602":53,"_603":604},"navMode","auto","structure","oneLayer","align","left","showIndexItem","showModuleItem","itemsMap",{"_3":605},{"_209":3,"_220":606},[],"versionList",[609],{"_209":610,"_22":611,"_233":51,"_231":202,"_612":53},"8284549","latest","disabled","resourceData",{"_5":223,"_615":616,"_633":634},"data",{"_209":263,"_22":264,"_617":144,"_24":618,"_619":251,"_620":621,"_247":248,"_622":623,"_624":625,"_626":627,"_628":627,"_5":144,"_229":629,"_630":631,"_632":-5},"sidebarTitle","\n \n \n![image.png](https://api.apifox.com/api/v1/projects/8510266/resources/671544/image-preview)\n \n \n\n![image.png](https://api.apifox.com/api/v1/projects/8510266/resources/671547/image-preview)\n \n \n\n![image.png](https://api.apifox.com/api/v1/projects/8510266/resources/671549/image-preview)\n \n \n\n \n\n\n\n\n\n> **Note**: The Key is only shown once when it's created. Please save it immediately. If you forget it, you'll need to delete it and create a new one.\n\n### Key Format\n\n```\nsk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\n```\n\nIt starts with `sk-`, followed by a string of random characters. Pass it in the `Authorization` HTTP header when making calls.\n\n---\n\n","folderId","projectId",8510266,"createdAt","2026-06-30T09:24:28.000Z","updatedAt","2026-07-01T05:42:08.000Z","creatorId",2244375,"editorId",[],"visibility","INHERITED","filePath","extraData",{"_635":636,"_644":645},"apiFieldList",[637],{"_5":624,"_195":638,"_22":639,"_640":625,"_641":642,"_643":51},"updateAt","Last modified:","value","format","2026-07-01 05:42:08","hidden","dataSchemaDefinitions",{},"docsIdTypeData",{"_648":649,"_650":651,"_620":621,"_652":653,"_654":655,"_656":657,"_658":144,"_659":-7},"onlineType","APIDOC","onlineId",5511794,"teamId",4498503,"branchId",8284549,"visitType","customDomain","subdirectory","specialFileType","notification",[],"footerBanner",[],"projectSetting",{"_666":667,"_540":669,"_697":698,"_699":700,"_701":702,"_703":704},"auth",{"_5":668},"securityscheme",{"_670":51,"_671":53,"_672":53,"_673":51,"_674":53,"_675":53,"_676":677,"_678":679,"_684":685,"_690":691,"_692":693},"allowAutomationWriteAutomationCreatedSprintBranch","enableJsonc","enableBigint","responseValidate","enableTestScenarioSetting","enableYAPICompatScript","isDefaultUrlEncoding",2,"publishedDocUrlRules",{"_680":681,"_682":683},"defaultRule","RESOURCE_KEY_ONLY","resourceKeyStandard","NEW","folderShareExpandModeSettings",{"_686":687,"_688":689},"expandId",[251],"mode","MANUAL","parameterDisplayMode","CLASSIC","sampleCode",{"_560":51,"_694":695,"_696":51},"autoGenerateFor","ALL","overwriteExisting","securityScheme",{},"mockSettings",{},"preProcessors",[],"postProcessors",[],"environments",{"_707":-7,"_708":709,"_710":711},"selectedEnvironment","environmentList",[],"servers",[712],{"_209":582,"_22":713},"默认服务","searchSettings",{},"versionSettings",[718],{"_654":655,"_719":51,"_22":611,"_720":611,"_705":721},"isDefaultVersion","slug",{"_722":723,"_724":208},"environmentIds",[],"defaultEnvironmentId","seoInfos",["M"],"itemPathPrefix",{"_729":144,"_730":144,"_658":144,"_731":53},"baseUrl","versionSlug","isSharedDocIndependentDomain","appEnvMap",{"_734":157},"appBrowserExtensionAdapterKey","customCodes",{"_737":144,"_738":739},"javascript","compiledCss","/* ==================================\nApifox 全文档字体颜色统一 #0f0f14\n覆盖：导航 + 正文 + 标题 + 表格 + 所有文本\n================================== */\n\n\n/* 让网站整体100% */\n#html .g-logo-img{\n width: 160px;\n}\n#html .g-header{\n max-width: 100%;\n}\n#html .SplitPane{\n max-width: 100%;\n}\n#html .text-color .break-word{\n font-weight: 500;\n}\n#html .g-sidebar-item-link-active{\n color:rgb(37, 99, 235);\n}\n/* 侧边栏整体 */\n#html .g-sidebar {\n background: #ffffff;\n width: 300px;\n}\n/* 导航项文字 */\n#html .g-sidebar .g-menu-item {\n color: #2c2f3d;\n font-size: 14px;\n}\n/* 选中项高亮 */\n#html .g-sidebar .g-menu-item.is-active {\n background: #e8f3ff;\n color: #1677ff;\n font-weight: 500;\n}\n/* 折叠箭头 */\n#html .g-sidebar .g-menu-item__arrow {\n color: #999;\n}\n/* 隐藏底部 Apifox 悬浮提示气泡 + 底部“用 Apifox”文字区域 */\n#html div:has-text(\"All-in-One API Platform\"),\n#html div:has-text(\"用 Apifox\") {\n display: none !important;\n visibility: hidden !important;\n height: 0 !important;\n overflow: hidden !important;\n}\n\n/* 兜底兼容低版本Apifox，定位底部品牌容器 */\n#html .g-footer-brand,\n#html .g-apifox-tip-popover,\n#html [class*=\"tip-popover\"] {\n display: none !important;\n}","primaryColorVariable",{"_491":742,"_497":743},"--ui-primary-color-hover: var(--ui-primary-5);--ui-primary-color-active: var(--ui-primary-7);--ui-picker-basic-cell-hover-with-range-color: #2d0e83;--ui-picker-date-hover-range-border-color: #4415c9;--ui-primary-base: rgba(126,87,237,1);--ui-primary-base-p: 126, 87, 237;--ui-primary-color-p: 126, 87, 237;--ui-primary-color: rgba(126,87,237,1);--ui-primary-10: #302350;--ui-primary-9: #48327e;--ui-primary-8: #563c9b;--ui-primary-7: #6a49c3;--ui-primary-7-p: 106, 73, 195;--ui-primary-6: rgba(126,87,237,1);--ui-primary-6-p: 126, 87, 237;--ui-primary-5: #a785f4;--ui-primary-5-p: 167, 133, 244;--ui-primary-4: #c7adf8;--ui-primary-3: #dac8fb;--ui-primary-2: #e8dcfd;--ui-primary-1: #f1eafe;--ui-primary-1-p: 241, 234, 254;--ui-primary-a: #f6f1fe;--ui-primary-b: #fbf8ff;--g-color-primary: rgba(126,87,237,1);--ui-btn-primary-color: #fff;--ui-lime-6-p: 160,217,17;--ui-orange-6-p: 250,140,22;--ui-yellow-6-p: 250,219,20;--ui-pink-6-p: 235,47,150;--ui-body-background: #ffffff;--theme-tars-item-active-bg: var(--ui-tree-node-selected-bg);--ifm-menu-color: var(--ui-text-color-sub);--ifm-menu-color-active: var(--ui-text-color-sub);--ifm-menu-color-background-hover: var(--ui-item-hover-bg);--theme-tars-border-color-split: var(--ui-border-color-split);","--ui-primary-color-hover: var(--ui-primary-7);--ui-primary-color-active: var(--ui-primary-5);--ui-picker-basic-cell-hover-with-range-color: #2d0e83;--ui-picker-date-hover-range-border-color: #4415c9;--ui-primary-base: rgba(126,87,237,1);--ui-primary-base-p: 126, 87, 237;--ui-primary-color-p: 126, 87, 237;--ui-primary-color: rgba(126,87,237,1);--ui-primary-10: #dfcefc;--ui-primary-9: #a785f4;--ui-primary-8: #b292f5;--ui-primary-7: #9c78f2;--ui-primary-7-p: 156, 120, 242;--ui-primary-6: rgba(126,87,237,1);--ui-primary-6-p: 126, 87, 237;--ui-primary-5: #a785f4;--ui-primary-5-p: 167, 133, 244;--ui-primary-4: #c7adf8;--ui-primary-3: #dac8fb;--ui-primary-2: #e4d5fc;--ui-primary-1: #f1eafe;--ui-primary-1-p: 241, 234, 254;--ui-primary-a: #f6f1fe;--ui-primary-b: #fbf8ff;--g-color-primary: rgba(126,87,237,1);--ui-btn-primary-color: #fff;--ui-lime-6-p: 160,217,17;--ui-orange-6-p: 250,140,22;--ui-yellow-6-p: 250,219,20;--ui-pink-6-p: 235,47,150;--ui-body-background: rgb(255, 255, 255);--theme-tars-item-active-bg: var(--ui-tree-node-selected-bg);--ifm-menu-color: var(--ui-text-color-sub);--ifm-menu-color-active: var(--ui-text-color-sub);--ifm-menu-color-background-hover: var(--ui-item-hover-bg);--theme-tars-border-color-split: var(--ui-border-color-split);","routes/_index/route","actionData","errors"]

Getting an API Key

Key Format#

Key Format