Theneo

Introduction

Integrate Compass with Theneo

Add a Project to a Compass Component

Remove the Project from a Compass Component

Remove the API Key from a Compass Component

Uninstall the Theneo App

Blank

<h3 class="slate-h3">What is Theneo?</h3><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">Theneo is an advanced AI-driven platform that automates the process of creating, managing, and publishing high-quality API documentation. Theneo lets you effortlessly visualize API documentation for your Compass components without the need for implementing complex logic.</p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets"></p><div style="text-align:center"><img src="https://theneo-prod-public.s3.amazonaws.com/images-1696317400921.png" alt="" id="1696317401150" width="806"/></div><p class="slate-p" placeholder="Type / for widgets"></p>

Theneo is an advanced AI-driven platform that automates the process of creating, managing, and publishing high-quality API documentation. Theneo lets you effortlessly visualize API documentation for your Compass components without the need for implementing complex logic.

<h3 class="slate-h3">Installation</h3><ul class="slate-ul"><li class="slate-li"><div style="position:relative">On Compass, select <strong class="slate-bold">Apps</strong> from the top menu bar.</div></li><li class="slate-li"><div style="position:relative">Locate the Theneo tile and select <strong class="slate-bold">Install</strong>.</div></li><li class="slate-li"><div style="position:relative">Once installed, select <strong class="slate-bold">Configure </strong>(accessible to admins only).</div></li></ul><h3 class="slate-h3">Setting Up the Integration</h3><ul class="slate-ul"><li class="slate-li"><div style="position:relative">Install Theneo App on Compass</div></li><li class="slate-li"><div style="position:relative">Navigate to the Compass app, and paste the copied Theneo API key. This links your Theneo account to Compass.</div></li><li class="slate-li"><div style="position:relative">You can either create a new API documentation project or link an existing one from Theneo.</div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p><div style="text-align:center"><img src="https://theneo-prod-public.s3.amazonaws.com/images-1697480237225.png" alt="" id="1697480237471" width="764"/></div><p class="slate-p" placeholder="Type / for widgets"></p>

<p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">You have several options for adding a project to Compass components:</p><h2 class="slate-h2">Upload a File</h2><ul class="slate-ul"><li class="slate-li"><div style="position:relative">Find the Compass component where you want to add the spec file and select &quot;Theneo.&quot;</div></li><li class="slate-li"><div style="position:relative">Navigate to the &quot;Upload File&quot; tab.</div></li><li class="slate-li"><div style="position:relative">Drag and drop the spec file onto the drop zone or use the drop zone to locate the file on your computer. The spec file can be up to 10MB.</div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p><div style="text-align:center"><img src="https://theneo-prod-public.s3.amazonaws.com/images-1696318504160.png" alt="" id="1696318504538" width="746"/></div><h2 class="slate-h2">Using Webhook</h2><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">If your spec file is part of your build process, you can use a webhook:</p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">Example using the cURL command:</p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets"><code class="slate-code">curl -F file=&lt;@FILE_NAME_TO_IMPORT&gt; -F project_name=&lt;PROJECT_NAME_TO_CREATE&gt; -F ai_option=&lt;none|full|enhance&gt; -H &quot;x-theneo-api-key:&lt;YOUR_API_KEY&gt;&quot; https://api.theneo.io/project/import/specfile</code></p><ul class="slate-ul"><li class="slate-li"><div style="position:relative">Replace <code class="slate-code">FILE_NAME_TO_IMPORT</code> with your .json file&apos;s name.</div></li><li class="slate-li"><div style="position:relative">Replace <code class="slate-code">PROJECT_NAME_TO_CREATE</code> with the project title you want to add.</div></li><li class="slate-li"><div style="position:relative">Replace <code class="slate-code">YOUR_API_KEY</code> with your Theneo API key.</div></li><li class="slate-li"><div style="position:relative">Choose one of the options for <code class="slate-code">ai_option</code>: none (no AI assistance), full (full AI assistance), or enhance (enhance existing content).</div></li></ul><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">The imported project will appear in the <strong class="slate-bold">Link Existing Project</strong> section.</p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets"></p><h2 class="slate-h2">Linking to an Existing Project</h2><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">From the dropdown menu, you can select from all published projects created within Theneo.</p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets"></p><h3 class="slate-h3">Transform Your API Documentation with AI</h3><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">Theneo offers AI assistance options for creating API documentation:</p><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Full AI Assistance</strong>: Allows AI to generate entirely new content, ensuring uniform and engaging documentation.</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Enhance Existing Content</strong>: Lets AI intelligently fill in only missing descriptions, preserving your existing content while enhancing it.</div></li></ul><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">
</p><div  data-type="info" style="background-color:#eef1ff;color:#4a59af"><div ><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">All created projects will be accessible from Theneo&apos;s dashboard, where you can manage various features, including custom menu, ChatGPT search, and branding.</p></div></div><p class="slate-p" placeholder="Type / for widgets"></p>

You have several options for adding a project to Compass components:

If your spec file is part of your build process, you can use a webhook:

curl -F file=&lt;@FILE_NAME_TO_IMPORT> -F project_name=&lt;PROJECT_NAME_TO_CREATE> -F ai_option=&lt;none|full|enhance> -H "x-theneo-api-key:&lt;YOUR_API_KEY>" https://api.theneo.io/project/import/specfile

From the dropdown menu, you can select from all published projects created within Theneo.

Theneo offers AI assistance options for creating API documentation:

<p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">You can remove the project by following these steps:</p><ul class="slate-ul"><li class="slate-li"><div style="position:relative">In your project view, on the right-top side, find the dropdown menu.</div></li><li class="slate-li"><div style="position:relative">Select the <strong class="slate-bold">Generate new project</strong> option.</div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p><div style="text-align:center"><img src="https://theneo-prod-public.s3.amazonaws.com/images-1697479893794.png" alt="" id="1697479893830" width="800"/></div><p class="slate-p" placeholder="Type / for widgets"></p>

You can remove the project by following these steps:

<p class="slate-p" placeholder="Type / for widgets">To remove the API key from a Compass component, follow these steps:</p><ul class="slate-ul"><li class="slate-li"><div style="position:relative">Navigate through the apps and find <strong class="slate-bold">Theneo</strong>.</div></li><li class="slate-li"><div style="position:relative">Click on <strong class="slate-bold">Configure</strong></div></li><li class="slate-li"><div style="position:relative">On the bottom right, you&apos;ll find the option to <strong class="slate-bold">Replace API Key</strong>.</div></li></ul><div  data-type="info" style="background-color:#eef1ff;color:#4a59af"><div ><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">Note that only administrators can perform this action.</p></div></div><div style="text-align:center"><img src="https://theneo-prod-public.s3.amazonaws.com/images-1697479552642.png" alt="" id="1697479553052" width="790"/></div><p class="slate-p" placeholder="Type / for widgets"></p>

To remove the API key from a Compass component, follow these steps:

<p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">If you decide to no longer use the Theneo app in your Compass instance, you can uninstall it easily:</p><ul class="slate-ul"><li class="slate-li"><div style="position:relative">Navigate to Compass and select <strong class="slate-bold">Apps</strong> from the top menu bar.</div></li><li class="slate-li"><div style="position:relative">Find the Theneo tile and select <strong class="slate-bold">Uninstall</strong>.
</div></li></ul><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">The Theneo app will be uninstalled, and Compass will no longer be integrated with Theneo.</p><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets"></p><div  data-type="info" style="background-color:#eef1ff;color:#4a59af"><div ><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p slate-indent-0" style="margin-left:0px" placeholder="Type / for widgets">It&apos;s important to note that all created projects will be saved on Theneo&apos;s dashboard, and even if you uninstall the Theneo app from Compass, you will still have access to your projects from Theneo&apos;s platform. </p></div></div><p class="slate-p" placeholder="Type / for widgets"></p>

If you decide to no longer use the Theneo app in your Compass instance, you can uninstall it easily:

The Theneo app will be uninstalled, and Compass will no longer be integrated with Theneo.

Sections