Manage the reply alias for the user associated with an API credential.
The profile API updates the authenticated user’s reply alias. It does not administer teammates or let a caller choose another user ID. A workspace API key needs an associated user identity for this operation.
Update my reply alias
Set or clear the saved alias used for human replies.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/schema.json","name":"Fini","description":"Documentation for Fini AI (usefini.com): build, deploy and run autonomous AI support agents. Fini is made by Fini Technologies Inc. and is not affiliated with fini.ai.","colors":{"primary":"#C3EE5E","light":"#C3EE5E","dark":"#A8D43E"},"logo":{"light":"https://mintcdn.com/fini/fep-JMymNphpe1DQ/images/shared/logos/fini-light.png?fit=max\u0026auto=format\u0026n=fep-JMymNphpe1DQ\u0026q=85\u0026s=a460ff8bb507876712db2f0fb12c21e4","dark":"https://mintcdn.com/fini/fep-JMymNphpe1DQ/images/shared/logos/fini-dark.png?fit=max\u0026auto=format\u0026n=fep-JMymNphpe1DQ\u0026q=85\u0026s=8a2bf1d8a0e5c590ebb976eadccf26a9"},"favicon":"https://mintcdn.com/fini/fep-JMymNphpe1DQ/images/shared/logos/fini-dark.png?fit=max\u0026auto=format\u0026n=fep-JMymNphpe1DQ\u0026q=85\u0026s=8a2bf1d8a0e5c590ebb976eadccf26a9","footer":{"socials":{"x":"https://x.com/finichatAI","linkedin":"https://www.linkedin.com/company/usefini","youtube":"https://www.youtube.com/@finiai","instagram":"https://www.instagram.com/usefini.official","github":"https://github.com/ask-fini"}},"seo":{"metatags":{"msvalidate.01":"9A9FD7AB87AE2DEA257FE41F07C61E70"}},"styling":{"latex":true},"navigation":{"languages":[{"language":"en","default":true,"href":"en/introduction"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"fini","hasAudioNarration":false,"actualSubdomain":"fini","customDomains":["docs.usefini.com"],"gitSource":{"type":"github","owner":"ask-fini","repo":"fini-docs","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae3875a9373b08c3f7cdf39","collectionId":"63921f54-05ed-4151-aa3d-6e8018a00508","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae3875a9373b08c3f7cdf39"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae3875a9373b08c3f7cdf39","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"en","tag":"API reference","count":206},{"language":"en","tag":"Documentation","count":55},{"language":"en","tag":"Knowledge","count":40},{"language":"en","tag":"Test Suite","count":31},{"language":"en","tag":"Use cases","count":29},{"language":"en","tag":"Deploy","count":20},{"language":"en","tag":"Intent Rules","count":18},{"language":"en","tag":"Conversations","count":13},{"language":"en","tag":"Agent Configuration","count":13},{"language":"en","tag":"Trust \u0026 pricing","count":13}]},"assistantConfig":{"deflection":{"enabled":true,"email":"[email protected]","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"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":"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":"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":"editor-version-history-v2","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","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},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"en/api-reference/profile","slug":"/en/api-reference/profile","pageMetadata":{"title":"Overview","description":"Manage the reply alias for the user associated with an API credential.","icon":"user","href":"/en/api-reference/profile"},"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: \"Manage the reply alias for the user associated with an API credential.\"\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={a:`a`,p:`p`,..._provideComponents(),...props.components},{Card}=_components;if(!Card)_missingMdxReference(`Card`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`The profile API updates the authenticated user’s reply alias. It does not administer teammates or let a caller choose another user ID. A workspace API key needs an associated user identity for this operation.`}),`\n`,_jsx(Card,{title:`Update my reply alias`,icon:`user-pen`,href:`/en/api-reference/update-my-profile`,children:_jsx(_components.p,{children:`Set or clear the saved alias used for human replies.`})}),`\n`,_jsxs(_components.p,{children:[`For the dashboard workflow, see `,_jsx(_components.a,{href:`/en/testing/inbox#choose-your-reply-display-name`,children:`Choose your reply display name`}),`.`]})]})}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":"Overview","description":"Manage the reply alias for the user associated with an API credential.","icon":"user","href":"/en/api-reference/profile"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"fini","siteName":"Fini","title":"Overview - Fini","relatedPagesConfig":{"enabled":true,"limit":3,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/en/api-reference/profile","matchLevel":0}}},"lastModified":"2026-10-29T17:50:30.932Z","originalFileLocation":"en/api-reference/profile.mdx","locale":"en"},"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=\"Manage the reply alias for the user associated with an API credential.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Fini\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintcdn.com/fini/fep-JMymNphpe1DQ/images/shared/logos/fini-dark.png?fit=max\u0026amp;auto=format\u0026amp;n=fep-JMymNphpe1DQ\u0026amp;q=85\u0026amp;s=8a2bf1d8a0e5c590ebb976eadccf26a9\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintcdn.com/fini/fep-JMymNphpe1DQ/images/shared/logos/fini-dark.png?fit=max\u0026amp;auto=format\u0026amp;n=fep-JMymNphpe1DQ\u0026amp;q=85\u0026amp;s=8a2bf1d8a0e5c590ebb976eadccf26a9\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintcdn.com/fini/fep-JMymNphpe1DQ/images/shared/logos/fini-dark.png?fit=max\u0026amp;auto=format\u0026amp;n=fep-JMymNphpe1DQ\u0026amp;q=85\u0026amp;s=8a2bf1d8a0e5c590ebb976eadccf26a9\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/png\" href=\"https://mintcdn.com/fini/fep-JMymNphpe1DQ/images/shared/logos/fini-dark.png?fit=max\u0026amp;auto=format\u0026amp;n=fep-JMymNphpe1DQ\u0026amp;q=85\u0026amp;s=8a2bf1d8a0e5c590ebb976eadccf26a9\">\u003cmeta data-mint-head property=\"og:title\" content=\"Overview - Fini\">\u003cmeta data-mint-head property=\"og:description\" content=\"Manage the reply alias for the user associated with an API credential.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Fini\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.usefini.com/en/api-reference/profile\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://fini.mintlify.app/_mintlify/api/og/v2?division=Profile\u0026amp;title=Overview\u0026amp;description=Manage+the+reply+alias+for+the+user+associated+with+an+API+credential.\u0026amp;theme=f0910fa1b0920527ac15e186\u0026amp;signature=135356487f317da1b48be1f120926e6667643a8b11bbd433cf1c9e963cf7f8ae\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Overview - Fini\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Manage the reply alias for the user associated with an API credential.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://fini.mintlify.app/_mintlify/api/og/v2?division=Profile\u0026amp;title=Overview\u0026amp;description=Manage+the+reply+alias+for+the+user+associated+with+an+API+credential.\u0026amp;theme=f0910fa1b0920527ac15e186\u0026amp;signature=135356487f317da1b48be1f120926e6667643a8b11bbd433cf1c9e963cf7f8ae\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"https://mintlify.s3.us-west-1.amazonaws.com/fini/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Fini\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#C3EE5E\">\u003cmeta data-mint-head name=\"msvalidate.01\" content=\"9A9FD7AB87AE2DEA257FE41F07C61E70\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.usefini.com/en/api-reference/profile\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/api-reference/profile.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.usefini.com/#organization\",\"name\":\"Fini\",\"url\":\"https://docs.usefini.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/fini/fep-JMymNphpe1DQ/images/shared/logos/fini-light.png?fit=max\u0026auto=format\u0026n=fep-JMymNphpe1DQ\u0026q=85\u0026s=a460ff8bb507876712db2f0fb12c21e4\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.usefini.com#website\",\"name\":\"Fini\",\"url\":\"https://docs.usefini.com\",\"publisher\":{\"@id\":\"https://docs.usefini.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.usefini.com/en/api-reference/profile#webpage\",\"url\":\"https://docs.usefini.com/en/api-reference/profile\",\"name\":\"Overview\",\"description\":\"Manage the reply alias for the user associated with an API credential.\",\"dateModified\":\"2026-10-29T17:50:30.932Z\",\"isPartOf\":{\"@id\":\"https://docs.usefini.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.usefini.com/en/api-reference/profile#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.usefini.com/en/api-reference/profile#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Fini\",\"item\":\"https://docs.usefini.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Overview\",\"item\":\"https://docs.usefini.com/en/api-reference/profile\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.usefini.com/en/api-reference/profile#article\",\"headline\":\"Overview\",\"name\":\"Overview\",\"description\":\"Manage the reply alias for the user associated with an API credential.\",\"url\":\"https://docs.usefini.com/en/api-reference/profile\",\"mainEntityOfPage\":{\"@id\":\"https://docs.usefini.com/en/api-reference/profile#webpage\"},\"dateModified\":\"2026-10-29T17:50:30.932Z\",\"publisher\":{\"@id\":\"https://docs.usefini.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.usefini.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Fini\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Fini","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/en/introduction"}]},{"tab":"API reference","pages":[{"group":"API Setup","icon":"sliders","pages":[{"title":"API overview","icon":"code-branch","href":"/en/api-reference/overview"},{"title":"API contract","icon":"code","href":"/en/api-reference/api-contract"},{"title":"Static IP Addresses","icon":"address-book","href":"/en/api-reference/static-ip"},{"title":"Database and Warehouse Connections","icon":"database","href":"/en/api-reference/database-warehouses"},{"title":"MCP Connections","icon":"plug","href":"/en/api-reference/connect-mcp"}]},{"group":"LLM Access","icon":"acorn","pages":[{"title":"Coding agents","icon":"robot","href":"/en/api-reference/coding-agents"},{"title":"Claude Plugin","icon":"puzzle-piece","href":"/en/api-reference/claude-connector"}]},{"group":"Agents","public":true,"icon":"robot","pages":[{"title":"Overview","icon":"robot","href":"/en/api-reference/agents"},{"title":"Create agent","api":"POST https://api-prod.usefini.com/v2/bots/public","href":"/en/api-reference/create-agent"},{"title":"List agents","api":"GET https://api-prod.usefini.com/v2/bots/public","href":"/en/api-reference/list-agents"},{"title":"Delete agent","api":"DELETE https://api-prod.usefini.com/v2/bots/{id}/public","href":"/en/api-reference/delete-agent"}]},{"group":"Analytics","public":true,"icon":"chart-line","pages":[{"title":"Overview","icon":"chart-line","href":"/en/api-reference/analytics"},{"title":"Get agent analytics","api":"GET https://api-prod.usefini.com/v2/bots/{id}/hc-analytics/public","href":"/en/api-reference/get-agent-analytics"},{"title":"Get agent analytics section","api":"GET https://api-prod.usefini.com/v2/bots/{id}/hc-analytics/{section}/public","href":"/en/api-reference/get-agent-analytics-section"}]},{"group":"Help Centers","public":true,"icon":"book-open","pages":[{"title":"Overview","icon":"book-open","href":"/en/api-reference/help-centers"},{"title":"List help centers","api":"GET https://api-prod.usefini.com/v2/helpcenter/list/public","href":"/en/api-reference/list-help-centers"},{"title":"Get help center analytics","api":"GET https://api-prod.usefini.com/v2/helpcenter/{id}/analytics/public","href":"/en/api-reference/get-help-center-analytics"},{"title":"Export help center analytics","api":"GET https://api-prod.usefini.com/v2/helpcenter/{id}/analytics/export/public","description":"Download article, search, or event analytics as CSV.","href":"/en/api-reference/export-help-center-analytics"}]},{"group":"Profile","public":true,"icon":"user","pages":[{"title":"Overview","icon":"user","href":"/en/api-reference/profile"},{"title":"Update my reply alias","api":"PATCH https://api-prod.usefini.com/v2/users/me/public","description":"Change the reply alias for the user associated with your API credential.","href":"/en/api-reference/update-my-profile"}]},{"group":"Macros","public":true,"icon":"message","pages":[{"title":"Overview","icon":"message","href":"/en/api-reference/macros"},{"title":"List macros","api":"GET https://api-prod.usefini.com/v2/macros/public","href":"/en/api-reference/list-macros"},{"title":"Get macro","api":"GET https://api-prod.usefini.com/v2/macros/{id}/public","href":"/en/api-reference/get-macro"},{"title":"Create macro","api":"POST https://api-prod.usefini.com/v2/macros/public","href":"/en/api-reference/create-macro"},{"title":"Update macro","api":"PATCH https://api-prod.usefini.com/v2/macros/{id}/public","href":"/en/api-reference/update-macro"},{"title":"Delete macro","api":"DELETE https://api-prod.usefini.com/v2/macros/{id}/public","href":"/en/api-reference/delete-macro"}]},{"group":"Prompts","public":true,"icon":"message","pages":[{"title":"Overview","icon":"message","href":"/en/api-reference/prompts"},{"title":"Get prompts","api":"GET https://api-prod.usefini.com/v2/bots/{id}/hc-prompt/public","href":"/en/api-reference/get-prompts"},{"title":"Get prompt history","api":"GET https://api-prod.usefini.com/v2/bots/{id}/hc-prompt/history/public","href":"/en/api-reference/get-prompt-history"},{"title":"Get prompt version","api":"GET https://api-prod.usefini.com/v2/bots/{id}/hc-prompt/{promptId}/public","href":"/en/api-reference/get-prompt-version"},{"title":"Update prompts","api":"POST https://api-prod.usefini.com/v2/bots/{id}/hc-prompt/public","href":"/en/api-reference/update-prompts"},{"title":"Create prompt draft version","api":"POST https://api-prod.usefini.com/v2/bots/{id}/hc-prompt/versions/public","href":"/en/api-reference/create-prompt-draft-version"},{"title":"Get prompt draft version","api":"GET https://api-prod.usefini.com/v2/bots/{id}/hc-prompt/versions/{versionId}/public","href":"/en/api-reference/get-prompt-draft-version"},{"title":"Publish prompt draft version","api":"POST https://api-prod.usefini.com/v2/bots/{id}/hc-prompt/versions/{versionId}/publish/public","href":"/en/api-reference/publish-prompt-draft-version"},{"title":"Delete prompt draft version","api":"DELETE https://api-prod.usefini.com/v2/bots/{id}/hc-prompt/versions/{versionId}/public","href":"/en/api-reference/delete-prompt-draft-version"},{"title":"List prompt lifecycle versions","api":"GET https://api-prod.usefini.com/v2/bots/{id}/hc-prompt/versions/public","href":"/en/api-reference/list-prompt-versions"},{"title":"Restore prompt version as draft","api":"POST https://api-prod.usefini.com/v2/bots/{id}/hc-prompt/versions/{versionId}/restore-as-draft/public","href":"/en/api-reference/restore-prompt-version-as-draft"}]},{"group":"Actions","public":true,"icon":"wand-magic-sparkles","pages":[{"title":"Overview","icon":"wand-magic-sparkles","href":"/en/api-reference/actions"},{"title":"List actions","api":"GET https://api-prod.usefini.com/v2/hc-tools/public","href":"/en/api-reference/list-actions"},{"title":"Get action","api":"GET https://api-prod.usefini.com/v2/hc-tools/{id}/public","href":"/en/api-reference/get-action"},{"title":"Create action","api":"POST https://api-prod.usefini.com/v2/hc-tools/public","href":"/en/api-reference/create-action"},{"title":"Update action","api":"PATCH https://api-prod.usefini.com/v2/hc-tools/{id}/public","href":"/en/api-reference/update-action"},{"title":"Delete action","api":"DELETE https://api-prod.usefini.com/v2/hc-tools/{id}/public","href":"/en/api-reference/delete-action"},{"title":"Test action","api":"POST https://api-prod.usefini.com/v2/hc-tools/{id}/test-run/public","href":"/en/api-reference/test-action"},{"title":"List agent assignments","api":"GET https://api-prod.usefini.com/v2/hc-tools/{id}/junctions/public","href":"/en/api-reference/list-action-agents"},{"title":"Assign to agents","api":"POST https://api-prod.usefini.com/v2/hc-tools/junctions/public","href":"/en/api-reference/assign-action-agents"}]},{"group":"Attributes","public":true,"icon":"id-card","pages":[{"title":"Overview","icon":"id-card","href":"/en/api-reference/attributes"},{"title":"List attributes","api":"GET https://api-prod.usefini.com/v2/hc-tools/public","href":"/en/api-reference/list-attributes"},{"title":"Get attribute","api":"GET https://api-prod.usefini.com/v2/hc-tools/{id}/public","href":"/en/api-reference/get-attribute"},{"title":"Create attribute","api":"POST https://api-prod.usefini.com/v2/hc-tools/public","href":"/en/api-reference/create-attribute"},{"title":"Update attribute","api":"PATCH https://api-prod.usefini.com/v2/hc-tools/{id}/public","href":"/en/api-reference/update-attribute"},{"title":"Delete attribute","api":"DELETE https://api-prod.usefini.com/v2/hc-tools/{id}/public","href":"/en/api-reference/delete-attribute"},{"title":"Test attribute","api":"POST https://api-prod.usefini.com/v2/hc-tools/{id}/test-run/public","href":"/en/api-reference/test-attribute"},{"title":"List agent assignments","api":"GET https://api-prod.usefini.com/v2/hc-tools/{id}/junctions/public","href":"/en/api-reference/list-attribute-agents"},{"title":"Assign to agents","api":"POST https://api-prod.usefini.com/v2/hc-tools/junctions/public","href":"/en/api-reference/assign-attribute-agents"}]},{"group":"External API calls","public":true,"icon":"plug","pages":[{"title":"Overview","icon":"plug","href":"/en/api-reference/actions-and-attributes"},{"title":"List external API calls","api":"GET https://api-prod.usefini.com/v2/api-function-configs/public","href":"/en/api-reference/list-data-steps"},{"title":"Get external API call","api":"GET https://api-prod.usefini.com/v2/api-function-configs/{id}/public","href":"/en/api-reference/get-data-step"},{"title":"Create external API call","api":"POST https://api-prod.usefini.com/v2/api-function-configs/public","href":"/en/api-reference/create-data-step"},{"title":"Update external API call","api":"PATCH https://api-prod.usefini.com/v2/api-function-configs/{id}/public","href":"/en/api-reference/update-data-step"},{"title":"Delete external API call","api":"DELETE https://api-prod.usefini.com/v2/api-function-configs/{id}/public","href":"/en/api-reference/delete-data-step"},{"title":"Test external API call","api":"POST https://api-prod.usefini.com/v2/api-function-configs/test-run/public","href":"/en/api-reference/test-data-step"}]},{"group":"Intent Rules","public":true,"icon":"route","pages":[{"title":"Overview","icon":"route","href":"/en/api-reference/intent-rules"},{"title":"List intent rules","api":"GET https://api-prod.usefini.com/v2/hc-rules/public","href":"/en/api-reference/list-intent-rules"},{"title":"Get intent rule","api":"GET https://api-prod.usefini.com/v2/hc-rules/{id}/public","href":"/en/api-reference/get-intent-rule"},{"title":"Get intent-rule fields context","api":"GET https://api-prod.usefini.com/v2/hc-rules/fields-context/public","href":"/en/api-reference/get-intent-rule-fields-context"},{"title":"Generate intent-rule draft with AI","api":"POST https://api-prod.usefini.com/v2/hc-rules/generate/public","href":"/en/api-reference/generate-intent-rule-draft"},{"title":"Create intent rule","api":"POST https://api-prod.usefini.com/v2/hc-rules/public","href":"/en/api-reference/create-intent-rule"},{"title":"Update intent rule","api":"PATCH https://api-prod.usefini.com/v2/hc-rules/{id}/public","href":"/en/api-reference/update-intent-rule"},{"title":"List intent-rule versions","api":"GET https://api-prod.usefini.com/v2/hc-rules/{id}/versions/public","href":"/en/api-reference/list-rule-versions"},{"title":"Get intent-rule version","api":"GET https://api-prod.usefini.com/v2/hc-rules/{id}/versions/{versionId}/public","href":"/en/api-reference/get-rule-version"},{"title":"Publish intent-rule draft","api":"POST https://api-prod.usefini.com/v2/hc-rules/{id}/publish/public","href":"/en/api-reference/publish-rule-draft"},{"title":"Unpublish intent rule","api":"POST https://api-prod.usefini.com/v2/hc-rules/{id}/unpublish/public","href":"/en/api-reference/unpublish-intent-rule"},{"title":"Restore intent-rule version as draft","api":"POST https://api-prod.usefini.com/v2/hc-rules/{id}/versions/{versionId}/restore-as-draft/public","href":"/en/api-reference/restore-rule-version-as-draft"},{"title":"Delete intent-rule draft version","api":"DELETE https://api-prod.usefini.com/v2/hc-rules/{id}/versions/{versionId}/public","href":"/en/api-reference/delete-rule-draft-version"},{"title":"Get rule version test paths","api":"GET https://api-prod.usefini.com/v2/hc-rules/{id}/versions/{versionId}/test-paths/public","href":"/en/api-reference/get-rule-version-test-paths"},{"title":"Preview rule test paths","api":"POST https://api-prod.usefini.com/v2/hc-rules/test-paths/config/public","href":"/en/api-reference/preview-rule-test-paths"},{"title":"Run rule version test path","api":"POST https://api-prod.usefini.com/v2/hc-rules/{id}/versions/{versionId}/test-paths/run/public","href":"/en/api-reference/run-rule-version-test-path"},{"title":"Run rule test path from config","api":"POST https://api-prod.usefini.com/v2/hc-rules/test-paths/config/run/public","href":"/en/api-reference/run-rule-test-path-config"},{"title":"Delete intent rule","api":"DELETE https://api-prod.usefini.com/v2/hc-rules/{id}/public","href":"/en/api-reference/delete-intent-rule"}]},{"group":"Guardrails","icon":"shield-check","pages":[{"title":"Overview","icon":"shield-check","href":"/en/api-reference/guardrails"},{"title":"List guardrail check types","api":"GET https://api-prod.usefini.com/v2/guardrail-policies/check-types/public","href":"/en/api-reference/list-guardrail-check-types"},{"title":"List guardrail policies","api":"GET https://api-prod.usefini.com/v2/guardrail-policies/public","href":"/en/api-reference/list-guardrail-policies"},{"title":"Get guardrail policy","api":"GET https://api-prod.usefini.com/v2/guardrail-policies/{id}/public","href":"/en/api-reference/get-guardrail-policy"},{"title":"Create guardrail policy","api":"POST https://api-prod.usefini.com/v2/guardrail-policies/public","href":"/en/api-reference/create-guardrail-policy"},{"title":"Update guardrail policy","api":"PUT https://api-prod.usefini.com/v2/guardrail-policies/{id}/public","href":"/en/api-reference/update-guardrail-policy"},{"title":"Delete guardrail policy","api":"DELETE https://api-prod.usefini.com/v2/guardrail-policies/{id}/public","href":"/en/api-reference/delete-guardrail-policy"},{"title":"List guardrail runs","api":"GET https://api-prod.usefini.com/v2/guardrail-policies/runs/public","href":"/en/api-reference/list-guardrail-runs"},{"title":"Get guardrail hits","api":"GET https://api-prod.usefini.com/v2/guardrail-policies/hits/public","href":"/en/api-reference/get-guardrail-hits"}]},{"group":"Business Rules","public":true,"icon":"briefcase","pages":[{"title":"Overview","icon":"briefcase","href":"/en/api-reference/business-rules"},{"title":"List Business Rules","api":"GET https://api-prod.usefini.com/v2/business-rules/public","href":"/en/api-reference/list-business-rules"},{"title":"Get Business Rule","api":"GET https://api-prod.usefini.com/v2/business-rules/{id}/public","href":"/en/api-reference/get-business-rule"},{"title":"Get Business Rule fields context","api":"GET https://api-prod.usefini.com/v2/business-rules/fields-context/public","href":"/en/api-reference/get-business-rule-fields-context"},{"title":"List default Business Rules","api":"GET https://api-prod.usefini.com/v2/business-rules/default/public","href":"/en/api-reference/list-default-rules"},{"title":"Create Business Rule","api":"POST https://api-prod.usefini.com/v2/business-rules/public","href":"/en/api-reference/create-business-rule"},{"title":"Duplicate Business Rule","api":"POST https://api-prod.usefini.com/v2/business-rules/{id}/duplicate/public","href":"/en/api-reference/duplicate-business-rule"},{"title":"Evaluate Business Rule","api":"POST https://api-prod.usefini.com/v2/business-rules/{id}/evaluate/public","href":"/en/api-reference/evaluate-business-rule"},{"title":"Get Business Rule test fields","api":"GET https://api-prod.usefini.com/v2/business-rules/{id}/test-fields/public","href":"/en/api-reference/get-business-rule-test-fields"},{"title":"Preview Business Rule test fields","api":"POST https://api-prod.usefini.com/v2/business-rules/test-fields/preview/public","href":"/en/api-reference/preview-business-rule-test-fields"},{"title":"Update Business Rule","api":"PATCH https://api-prod.usefini.com/v2/business-rules/{id}/public","href":"/en/api-reference/update-business-rule"},{"title":"Delete Business Rule","api":"DELETE https://api-prod.usefini.com/v2/business-rules/{id}/public","href":"/en/api-reference/delete-business-rule"}]},{"group":"Reply Rules","public":true,"icon":"reply-all","pages":[{"title":"Overview","icon":"reply-all","href":"/en/api-reference/reply-rules"},{"title":"Get reply rules","api":"GET https://api-prod.usefini.com/v2/reply-behavior/public","href":"/en/api-reference/get-reply-rules"},{"title":"Get reply rule fields context","api":"GET https://api-prod.usefini.com/v2/reply-behavior/fields-context/public","href":"/en/api-reference/get-reply-rule-fields-context"},{"title":"Update reply rule","api":"PUT https://api-prod.usefini.com/v2/reply-behavior/{replyType}/public","href":"/en/api-reference/update-reply-rule"}]},{"group":"Tag groups","public":true,"icon":"tag","pages":[{"title":"Overview","icon":"tag","href":"/en/api-reference/tag-groups"},{"title":"List tag groups","api":"GET https://api-prod.usefini.com/v2/tag-groups/public","href":"/en/api-reference/list-tag-groups"},{"title":"Get tag group","api":"GET https://api-prod.usefini.com/v2/tag-groups/{id}/public","href":"/en/api-reference/get-tag-group"},{"title":"Create tag group","api":"POST https://api-prod.usefini.com/v2/tag-groups/public","href":"/en/api-reference/create-tag-group"},{"title":"Update tag group","api":"PUT https://api-prod.usefini.com/v2/tag-groups/{id}/public","href":"/en/api-reference/update-tag-group"},{"title":"Delete tag group","api":"DELETE https://api-prod.usefini.com/v2/tag-groups/{id}/public","href":"/en/api-reference/delete-tag-group"}]},{"group":"Tags","public":true,"icon":"tag","pages":[{"title":"Overview","icon":"tag","href":"/en/api-reference/tags"},{"title":"Get tag","api":"GET https://api-prod.usefini.com/v2/tags/{id}/public","href":"/en/api-reference/get-tag"},{"title":"List tags in group","api":"GET https://api-prod.usefini.com/v2/tag-groups/{id}/tags/public","href":"/en/api-reference/list-tags-in-group"},{"title":"List tags across groups","api":"GET https://api-prod.usefini.com/v2/tag-groups/tags/public","href":"/en/api-reference/list-tags-across-groups"},{"title":"Create tag","api":"POST https://api-prod.usefini.com/v2/tag-groups/{id}/tags/public","href":"/en/api-reference/create-tag"},{"title":"Update tag","api":"PUT https://api-prod.usefini.com/v2/tag-groups/tags/{id}/public","href":"/en/api-reference/update-tag"},{"title":"Delete tag","api":"DELETE https://api-prod.usefini.com/v2/tag-groups/tags/{id}/public","href":"/en/api-reference/delete-tag"}]},{"group":"Conversations","public":true,"icon":"address-book","pages":[{"title":"Overview","icon":"address-book","href":"/en/api-reference/conversations"},{"title":"List conversations","api":"GET https://api-prod.usefini.com/v2/hc-interactions/public","href":"/en/api-reference/list-conversations"},{"title":"Get conversation","api":"GET https://api-prod.usefini.com/v2/hc-interactions/{id}/public","href":"/en/api-reference/get-conversation"},{"title":"Get conversation memories","api":"GET https://api-prod.usefini.com/v2/hc-interactions/{id}/memories/public","href":"/en/api-reference/get-conversation-memories"},{"title":"Get event metadata","api":"GET https://api-prod.usefini.com/v2/hc-events/{id}/metadata","href":"/en/api-reference/get-event-metadata"},{"title":"Generate Answer","api":"POST https://api-prod.usefini.com/v2/hc-interactions/events/public","href":"/en/api-reference/generate-answer"},{"title":"Send conversation feedback","api":"POST https://api-prod.usefini.com/v2/hc-interactions/{id}/feedback/public","href":"/en/api-reference/send-feedback-conversation"},{"title":"Mark feedback resolved","api":"POST https://api-prod.usefini.com/v2/hc-interactions/{id}/feedback-resolved/public","href":"/en/api-reference/resolve-conversation-feedback"},{"title":"Add feedback note","api":"POST https://api-prod.usefini.com/v2/hc-interactions/{id}/feedback-note/public","href":"/en/api-reference/add-conversation-feedback-note"},{"title":"Add internal note","api":"POST https://api-prod.usefini.com/v2/hc-interactions/{id}/internal-note/public","href":"/en/api-reference/add-conversation-internal-note"},{"title":"Evaluate conversation rule","api":"POST https://api-prod.usefini.com/v2/hc-interactions/{id}/evaluate-rule/{ruleId}/public","href":"/en/api-reference/evaluate-conversation-rule"},{"title":"Delete conversation","api":"DELETE https://api-prod.usefini.com/v2/hc-interactions/{id}/public","href":"/en/api-reference/delete-conversation"},{"title":"Bulk delete conversations","api":"DELETE https://api-prod.usefini.com/v2/hc-interactions/public","href":"/en/api-reference/bulk-delete-conversations"}]},{"group":"Refine with AI","public":true,"icon":"wand-magic-sparkles","pages":[{"title":"Overview","icon":"wand-magic-sparkles","href":"/en/api-reference/refine-with-ai"},{"title":"Create Refine with AI iteration","api":"POST https://api-prod.usefini.com/v2/fix-review/interactions/{id}/events/{eventId}/sessions/iterations/public","href":"/en/api-reference/create-fix-review-iteration"},{"title":"Get active Refine with AI session","api":"GET https://api-prod.usefini.com/v2/fix-review/interactions/{id}/events/{eventId}/session/public","href":"/en/api-reference/get-active-fix-review-session"},{"title":"Get Refine with AI session","api":"GET https://api-prod.usefini.com/v2/fix-review/interactions/{id}/events/{eventId}/sessions/{sessionId}/public","href":"/en/api-reference/get-fix-review-session"}]},{"group":"Replays","public":true,"icon":"arrow-rotate-right","pages":[{"title":"Replays","icon":"arrow-rotate-right","href":"/en/api-reference/replays"},{"title":"Create replay","api":"POST https://api-prod.usefini.com/v2/replays/public","href":"/en/api-reference/create-replay"},{"title":"List replays","api":"GET https://api-prod.usefini.com/v2/replays/interactions/{interactionId}/public","href":"/en/api-reference/list-replays"},{"title":"Get replay","api":"GET https://api-prod.usefini.com/v2/replays/{id}/public","href":"/en/api-reference/get-replay"},{"title":"Get replay events","api":"GET https://api-prod.usefini.com/v2/replays/{id}/events/public","href":"/en/api-reference/get-replay-events"}]},{"group":"Test Suite","public":true,"icon":"vial","pages":[{"title":"Overview","icon":"vial","href":"/en/api-reference/test-suite"},{"title":"List criteria groups","api":"GET https://api-prod.usefini.com/v2/test-suite/criteria-groups/public","href":"/en/api-reference/list-test-suite-criteria-groups"},{"title":"Create criteria group","api":"POST https://api-prod.usefini.com/v2/test-suite/criteria-groups/public","href":"/en/api-reference/create-test-suite-criteria-group"},{"title":"Get criteria group","api":"GET https://api-prod.usefini.com/v2/test-suite/criteria-groups/{id}/public","href":"/en/api-reference/get-test-suite-criteria-group"},{"title":"Update criteria group","api":"PATCH https://api-prod.usefini.com/v2/test-suite/criteria-groups/{id}/public","href":"/en/api-reference/update-test-suite-criteria-group"},{"title":"Add cases to criteria group","api":"POST https://api-prod.usefini.com/v2/test-suite/criteria-groups/{id}/cases/public","href":"/en/api-reference/add-test-suite-group-cases"},{"title":"Remove cases from criteria group","api":"DELETE https://api-prod.usefini.com/v2/test-suite/criteria-groups/{id}/cases/public","href":"/en/api-reference/remove-test-suite-group-cases"},{"title":"Add conversations to criteria group","api":"POST https://api-prod.usefini.com/v2/test-suite/criteria-groups/{id}/conversations/public","href":"/en/api-reference/add-test-suite-group-conversations"},{"title":"Get Test Suite fields context","api":"GET https://api-prod.usefini.com/v2/test-suite/fields-context/public","href":"/en/api-reference/get-test-suite-fields-context"},{"title":"Create library criterion","api":"POST https://api-prod.usefini.com/v2/test-suite/criteria/public","href":"/en/api-reference/create-test-suite-criterion"},{"title":"Get run configuration","api":"GET https://api-prod.usefini.com/v2/test-suite/run-configuration/public","href":"/en/api-reference/get-test-suite-run-configuration"},{"title":"List Action fixtures","api":"GET https://api-prod.usefini.com/v2/test-suite/action-fixtures/public","href":"/en/api-reference/list-test-suite-action-fixtures"},{"title":"List test cases","api":"GET https://api-prod.usefini.com/v2/test-suite/cases/public","href":"/en/api-reference/list-test-suite-cases"},{"title":"Get conversation input","api":"GET https://api-prod.usefini.com/v2/test-suite/conversation-input/public","href":"/en/api-reference/get-test-suite-conversation-input"},{"title":"Create test case","api":"POST https://api-prod.usefini.com/v2/test-suite/cases/public","href":"/en/api-reference/create-test-suite-case"},{"title":"Get test case","api":"GET https://api-prod.usefini.com/v2/test-suite/cases/{id}/public","href":"/en/api-reference/get-test-suite-case"},{"title":"Update test case","api":"PATCH https://api-prod.usefini.com/v2/test-suite/cases/{id}/public","href":"/en/api-reference/update-test-suite-case"},{"title":"Delete test case","api":"DELETE https://api-prod.usefini.com/v2/test-suite/cases/{id}/public","href":"/en/api-reference/delete-test-suite-case"},{"title":"List collections","api":"GET https://api-prod.usefini.com/v2/test-suite/folders/public","href":"/en/api-reference/list-test-suite-collections"},{"title":"Create collection","api":"POST https://api-prod.usefini.com/v2/test-suite/folders/public","href":"/en/api-reference/create-test-suite-collection"},{"title":"Delete collection","api":"DELETE https://api-prod.usefini.com/v2/test-suite/folders/{id}/public","href":"/en/api-reference/delete-test-suite-collection"},{"title":"Add cases to collection","api":"POST https://api-prod.usefini.com/v2/test-suite/folders/{id}/cases/public","href":"/en/api-reference/add-test-suite-collection-cases"},{"title":"Add criteria groups to collection","api":"POST https://api-prod.usefini.com/v2/test-suite/folders/{id}/groups/public","href":"/en/api-reference/add-test-suite-collection-groups"},{"title":"Remove cases from collection","api":"DELETE https://api-prod.usefini.com/v2/test-suite/folders/{id}/cases/public","href":"/en/api-reference/remove-test-suite-collection-cases"},{"title":"Remove criteria groups from collection","api":"DELETE https://api-prod.usefini.com/v2/test-suite/folders/{id}/groups/public","href":"/en/api-reference/remove-test-suite-collection-groups"},{"title":"List runs","api":"GET https://api-prod.usefini.com/v2/test-suite/runs/public","href":"/en/api-reference/list-test-suite-runs"},{"title":"Get Test Suite summary","api":"GET https://api-prod.usefini.com/v2/test-suite/summary/public","href":"/en/api-reference/get-test-suite-summary"},{"title":"Preview run readiness","api":"POST https://api-prod.usefini.com/v2/test-suite/runs/preview/public","href":"/en/api-reference/preview-test-suite-run"},{"title":"Start run","api":"POST https://api-prod.usefini.com/v2/test-suite/runs/public","href":"/en/api-reference/start-test-suite-run"},{"title":"Get run","api":"GET https://api-prod.usefini.com/v2/test-suite/runs/{id}/public","href":"/en/api-reference/get-test-suite-run"},{"title":"Save missing Action mock","api":"POST https://api-prod.usefini.com/v2/test-suite/case-runs/{id}/action-mocks/public","href":"/en/api-reference/save-test-suite-missing-action-mock"}]},{"group":"Knowledge","public":true,"icon":"hexagon-nodes","pages":[{"group":"Sources","icon":"book-open","pages":[{"title":"Overview","icon":"book-open","href":"/en/api-reference/sources"},{"title":"List sources","api":"GET https://api-prod.usefini.com/v2/documents/public","href":"/en/api-reference/list-sources"},{"title":"Get source","api":"GET https://api-prod.usefini.com/v2/documents/public/{id}","href":"/en/api-reference/get-source"},{"title":"List provider resources","api":"GET https://api-prod.usefini.com/v2/documents/public/resources/{provider}","href":"/en/api-reference/list-provider-resources"},{"title":"Register provider resources","api":"POST https://api-prod.usefini.com/v2/documents/public/resources/{provider}","href":"/en/api-reference/register-provider-resources"},{"title":"Ingest sources","api":"POST https://api-prod.usefini.com/v2/documents/public","href":"/en/api-reference/ingest-sources"},{"title":"Crawl links","api":"POST https://api-prod.usefini.com/v2/documents/public/deep-crawl/links","href":"/en/api-reference/deep-crawl-links"},{"title":"Refresh sources","api":"POST https://api-prod.usefini.com/v2/documents/public/refresh","href":"/en/api-reference/refresh-sources"},{"title":"Delete sources","api":"DELETE https://api-prod.usefini.com/v2/documents/public","href":"/en/api-reference/delete-sources"}]},{"group":"Knowledge generation","icon":"wand-magic-sparkles","pages":[{"title":"Overview","icon":"wand-magic-sparkles","href":"/en/api-reference/knowledge"},{"title":"Initialize knowledge folders","api":"POST https://api-prod.usefini.com/v2/knowledge/public/tree/initialize","href":"/en/api-reference/initialize-knowledge-folders"},{"title":"Persist knowledge folders","api":"POST https://api-prod.usefini.com/v2/knowledge/public/tree/persist","href":"/en/api-reference/persist-knowledge-folders"},{"title":"Generate knowledge","api":"POST https://api-prod.usefini.com/v2/knowledge/public","href":"/en/api-reference/generate-knowledge"},{"title":"Bulk generate knowledge","api":"POST https://api-prod.usefini.com/v2/knowledge/public/bulk","href":"/en/api-reference/bulk-generate-knowledge"},{"title":"Check knowledge jobs","api":"POST https://api-prod.usefini.com/v2/knowledge/public/jobs/status","href":"/en/api-reference/check-knowledge-jobs"}]},{"group":"Articles","icon":"book-open","pages":[{"title":"Overview","icon":"book-open","href":"/en/api-reference/manage-knowledge"},{"title":"List articles","api":"GET https://api-prod.usefini.com/v2/hc-articles/public","href":"/en/api-reference/list-articles"},{"title":"Get articles by IDs","api":"POST https://api-prod.usefini.com/v2/hc-articles/ids/public","href":"/en/api-reference/get-articles-by-ids"},{"title":"Create article","api":"POST https://api-prod.usefini.com/v2/hc-articles/public","href":"/en/api-reference/create-article"},{"title":"Update article","api":"PUT https://api-prod.usefini.com/v2/hc-articles/{id}/public","href":"/en/api-reference/update-article"},{"title":"Create article draft","api":"POST https://api-prod.usefini.com/v2/hc-articles/{id}/draft/public","href":"/en/api-reference/create-article-draft"},{"title":"Publish article draft","api":"POST https://api-prod.usefini.com/v2/hc-articles/{id}/publish/public","href":"/en/api-reference/publish-article-draft"},{"title":"List article history","api":"GET https://api-prod.usefini.com/v2/hc-articles/{id}/history/public","href":"/en/api-reference/list-article-history"},{"title":"Get article history version","api":"POST https://api-prod.usefini.com/v2/hc-articles/{id}/history/public","href":"/en/api-reference/get-article-history-version"},{"title":"Revert article version","api":"POST https://api-prod.usefini.com/v2/hc-articles/{id}/revert/public","href":"/en/api-reference/revert-article-version"},{"title":"Delete article","api":"DELETE https://api-prod.usefini.com/v2/hc-articles/{id}/public","href":"/en/api-reference/delete-article"}]},{"group":"Folders \u0026 assignments","icon":"folder","pages":[{"title":"Overview","icon":"folder","href":"/en/api-reference/organize-knowledge"},{"title":"Get knowledge folders","api":"GET https://api-prod.usefini.com/v2/hc-folders/public","href":"/en/api-reference/get-knowledge-folders"},{"title":"Create knowledge folder","api":"POST https://api-prod.usefini.com/v2/hc-folders/public","href":"/en/api-reference/create-knowledge-folder"},{"title":"Update knowledge folder","api":"PUT https://api-prod.usefini.com/v2/hc-folders/{id}/public","href":"/en/api-reference/update-knowledge-folder"},{"title":"Move knowledge folder","api":"PUT https://api-prod.usefini.com/v2/hc-folders/{id}/move/public","href":"/en/api-reference/move-knowledge-folder"},{"title":"Move article","api":"PUT https://api-prod.usefini.com/v2/hc-articles/{id}/move/public","href":"/en/api-reference/move-article"},{"title":"Delete knowledge folder","api":"DELETE https://api-prod.usefini.com/v2/hc-folders/{id}/public","href":"/en/api-reference/delete-knowledge-folder"},{"title":"Assign knowledge to agents","api":"POST https://api-prod.usefini.com/v2/hc-bot-folder-junctions/public","href":"/en/api-reference/assign-knowledge-to-agents"}]}]},{"group":"Updates","icon":"clock-rotate-left","pages":[{"title":"Changelog","icon":"clock-rotate-left","href":"/en/changelog"}]}]},{"tab":"Use cases","pages":[{"title":"Use cases","href":"/en/use-cases/refunds"}]},{"tab":"Trust \u0026 pricing","pages":[{"title":"Trust \u0026 pricing","href":"/en/security/overview"}]}]}]},"title":"Overview - Fini","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":[],"chunks":[]}