{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Equos Doc","colors":{"primary":"#0055FE","light":"#60ADFF","dark":"#041133"},"logo":{"light":"https://mintcdn.com/equos/miMDl3Al0ju5m4qh/logo/light.svg?fit=max\u0026auto=format\u0026n=miMDl3Al0ju5m4qh\u0026q=85\u0026s=e40480e27739ba4da5e934af31ace574","dark":"https://mintcdn.com/equos/miMDl3Al0ju5m4qh/logo/dark.svg?fit=max\u0026auto=format\u0026n=miMDl3Al0ju5m4qh\u0026q=85\u0026s=8b07311ba416d97dbc6e81ab33f90e02"},"favicon":"https://mintcdn.com/equos/4otJw5XojccDaWsR/images/favicon.png?fit=max\u0026auto=format\u0026n=4otJw5XojccDaWsR\u0026q=85\u0026s=210d944b45d3e27b7f63c48cf155bbd3","navbar":{"links":[{"href":"https://docs.google.com/forms/d/e/1FAIpQLSdoK7LvORdQf7KOQKvhhlESStJcKc3bDB9HPsEet6LuOmVUfQ/viewform","label":"Support"}],"primary":{"type":"button","label":"Studio","href":"https://studio.equos.ai"}},"footer":{"socials":{"github":"https://github.com/EquosAI","linkedin":"https://www.linkedin.com/company/equos-ai"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"GitHub","icon":"github","href":"https://github.com/EquosAI"},{"anchor":"Community","icon":"slack","href":"https://join.slack.com/t/equosaicommunity/shared_invite/zt-3d8oy19au-jZpsJB0i~gdL0jbDswdzzQ"},{"anchor":"Blog","icon":"newspaper","href":"https://equos.ai/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"equos","hasAudioNarration":false,"actualSubdomain":"equos","customDomains":["docs.equos.ai"],"gitSource":{"type":"github","owner":"equosai","repo":"equos-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21f6622af1650193593426","collectionId":"fc648c56-3205-4a80-bd70-10eb571e1f26","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21f6622af1650193593426:success","clientVersion":"0.0.3908","searchFilterCounts":[{"language":"default","tag":"API reference","count":34},{"language":"default","tag":"Guides","count":16},{"language":"default","tag":"KnowledgeBase","count":7},{"language":"default","tag":"SDKs","count":5},{"language":"default","tag":"Brain","count":5},{"language":"default","tag":"Character","count":5},{"language":"default","tag":"Voice","count":5},{"language":"default","tag":"Getting started","count":4},{"language":"default","tag":"Integration","count":4},{"language":"default","tag":"Conversation","count":4}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2-autocommit","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"teamspace","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"client-snapshot-docs-config","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"sdks/react","slug":"/sdks/react","pageMetadata":{"title":"React","description":"Get started with the Equos React Toolkit to build interactive AI experiences on the Web.","href":"/sdks/react"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Get started with the Equos React Toolkit to build interactive AI experiences on the Web.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{Card,CodeBlock,Columns,Heading}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Columns)_missingMdxReference(`Columns`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`installation`,children:`Installation`}),`\n`,_jsx(_components.p,{children:`Install Equos React SDK via npm:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`npm`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` i`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` @equos/react`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`usage`,children:`Usage`}),`\n`,_jsx(_components.p,{children:`Usage is described in the package documentation.`}),`\n`,_jsxs(Columns,{cols:2,children:[_jsx(Card,{icon:`npm`,title:`View package on NPM`,href:`https://www.npmjs.com/package/@equos/react`,children:_jsx(_components.p,{children:`View the package on NPM.`})}),_jsx(Card,{icon:`github`,title:`View code examples on GitHub`,href:`https://github.com/EquosAI/equos-examples/blob/main/README.md`,children:_jsx(_components.p,{children:`View code examples on GitHub.`})})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"React","description":"Get started with the Equos React Toolkit to build interactive AI experiences on the Web.","href":"/sdks/react"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Installation","slug":"installation","depth":2,"children":[]},{"title":"Usage","slug":"usage","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"equos","siteName":"Equos Doc","title":"React - Equos Doc","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-22T10:06:02.333Z","originalFileLocation":"sdks/react.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Get started with the Equos React Toolkit to build interactive AI experiences on the Web.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Equos Doc\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/equos/wFao6eCa560HqAHz/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/equos/wFao6eCa560HqAHz/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/equos/wFao6eCa560HqAHz/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/equos/wFao6eCa560HqAHz/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/equos/wFao6eCa560HqAHz/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/equos/wFao6eCa560HqAHz/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/equos/wFao6eCa560HqAHz/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/equos/wFao6eCa560HqAHz/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/equos/wFao6eCa560HqAHz/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"React - Equos Doc\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get started with the Equos React Toolkit to build interactive AI experiences on the Web.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Equos Doc\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.equos.ai/sdks/react\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"React - Equos Doc\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get started with the Equos React Toolkit to build interactive AI experiences on the Web.\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/equos/wFao6eCa560HqAHz/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Equos Doc\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0055FE\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.equos.ai/sdks/react\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/sdks/react.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.equos.ai/#organization\",\"name\":\"Equos Doc\",\"url\":\"https://docs.equos.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/equos/miMDl3Al0ju5m4qh/logo/light.svg?fit=max\u0026auto=format\u0026n=miMDl3Al0ju5m4qh\u0026q=85\u0026s=e40480e27739ba4da5e934af31ace574\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.equos.ai#website\",\"name\":\"Equos Doc\",\"url\":\"https://docs.equos.ai\",\"publisher\":{\"@id\":\"https://docs.equos.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.equos.ai/sdks/react#webpage\",\"url\":\"https://docs.equos.ai/sdks/react\",\"name\":\"React\",\"description\":\"Get started with the Equos React Toolkit to build interactive AI experiences on the Web.\",\"dateModified\":\"2026-04-22T10:06:02.333Z\",\"isPartOf\":{\"@id\":\"https://docs.equos.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.equos.ai/sdks/react#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.equos.ai/sdks/react#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"SDKs\",\"item\":\"https://docs.equos.ai/sdks/nodejs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"React\",\"item\":\"https://docs.equos.ai/sdks/react\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.equos.ai/sdks/react#article\",\"headline\":\"React\",\"name\":\"React\",\"description\":\"Get started with the Equos React Toolkit to build interactive AI experiences on the Web.\",\"url\":\"https://docs.equos.ai/sdks/react\",\"mainEntityOfPage\":{\"@id\":\"https://docs.equos.ai/sdks/react#webpage\"},\"dateModified\":\"2026-04-22T10:06:02.333Z\",\"publisher\":{\"@id\":\"https://docs.equos.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.equos.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Equos Doc\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Equos Doc","nav":{"global":{"anchors":[{"anchor":"GitHub","icon":"github","href":"https://github.com/EquosAI"},{"anchor":"Community","icon":"slack","href":"https://join.slack.com/t/equosaicommunity/shared_invite/zt-3d8oy19au-jZpsJB0i~gdL0jbDswdzzQ"},{"anchor":"Blog","icon":"newspaper","href":"https://equos.ai/blog"}]},"tabs":[{"tab":"Guides","groups":[{"group":"Getting started","pages":[{"title":"Introduction","href":""},{"group":"Quickstart","icon":"bolt","pages":[{"title":"Set up your organization","href":"/quickstart/setup"},{"title":"Chat with your character","href":"/quickstart/chat-with-character"}]},{"title":"On-Device Rendering","href":"/on-device-rendering"}]},{"group":"Recipes","pages":[{"title":"Create API Keys","href":"/recipes/create-api-key"},{"title":"Create a Knowledge Base","href":"/recipes/create-knowledge-base"},{"title":"Create a Character","href":"/recipes/create-character"}]},{"group":"Integration","pages":[{"title":"Overview","href":"/integration/overview"},{"title":"Backend","href":"/integration/backend"},{"title":"Web","href":"/integration/web"},{"title":"Native (iOS \u0026 Android)","href":"/integration/native"}]},{"group":"SDKs","pages":[{"title":"NodeJS","href":"/sdks/nodejs"},{"title":"Browser","description":"Get started with the Equos Browser SDK to build interactive AI experiences on the Web.","href":"/sdks/browser"},{"title":"React","href":"/sdks/react"},{"title":"Python","description":"Get started with the Equos Python SDK to build interactive AI experiences with ease using Python.","href":"/sdks/python"},{"title":"iOS","href":"/sdks/ios"}]}]},{"tab":"API reference","pages":[{"title":"API reference","href":"/api-reference/character/list-equos-characters"}]}]},"title":"React - Equos Doc","buildId":"dpl_CUnGQP1HgFUzoxatVC37y4zP83Vx","deploymentId":"dpl_CUnGQP1HgFUzoxatVC37y4zP83Vx","dynamics":[],"chunks":[]}