Theneo

Theneo Quickstart Guide

API Reference

API Import & Specs

API Testing

API Changelog

API Versioning

Theneo Documentation

Editor

Web Editor Widgets

Live Collaboration

Preview Changes

Automation & Dev Tools

Github Actions

Visual Studio Code Extension

Theneo CLI

Theneo SDK

Bitbucket

AI Co-pilot & Chat

AI co-pilot

AI chat / chatGPT

Branding & Styling

Customizing project look

Custom domain

Custom analytics

Developer Portal

Developer portal styling

Templates

Custom design

Developer portal editor

Export / Import Code

Workspaces & Project Management

Workspace Configuration

Project Management

Product & User Guides / Docs

Getting Started

Theneo Guide

Theneo Quickstart Guide - discover how Theneo can generate Stipe-like API docs

Theneo User Guide

Production

Sandbox

<p class="slate-p " >Creating intuitive, detailed, and easy-to-navigate API documentation has never been easier. Theneo streamlines every step of the process, ensuring that your documentation is not only comprehensive but also interactive and user-friendly. Here&apos;s how you can quickly set up your project in Theneo</p><div style="text-align:center"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/9e442a2e-a6f2-47ec-8aca-6cdea5ff6827.png" style="
              width:788px;
	            height:443px;
	            aspect-ratio:788 / 443"
         /></div><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><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 " >Before we dive into steps, did you know that you can use Theneo to create guides as well? if you would like to see guides for generating other type of docs other than APIs, please go <a href="https://app.theneo.io/theneo/quickstart/product-and-user-guides-docs" target="_top">here</a>.</p></div></div><p class="slate-p " >For <strong class="slate-bold">API docs</strong>, the steps are very simple</p><p class="slate-p " >When you log into Theneo, start by adding a new project from the homepage. Your project could be an API reference, a developer guide, or any type of documentation you need. Give your project a title, select the appropriate workspace, and you&apos;re on your way. For detailed instructions on workspaces, check out our guides</p><p class="slate-p " ></p><div class="steps-widget" style="width:100%;
  	min-width:100%;"><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >1</h6><h3 class="slate-h3 " >Uploading Your API Specification</h3><p class="slate-p " >Theneo accommodates a wide array of API specifications, making it easy to get started regardless of whether you have an existing spec or not. If you&apos;re equipped with Swagger, OpenAPI, GraphQL, or another format, the upload process is designed to be straightforward and efficient.</p><p class="slate-p " >In case you don&apos;t have a spec ready, Theneo offers tools to help you create one from scratch. Use our intuitive interface to define your API endpoints directly within the platform. For additional guidance on creating or importing your spec and ensuring format compatibility, check out our guide.</p><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><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 " >If you do not have a spec, do not worry you can define that in Theneo as well, for more info click <a href="https://app.theneo.io/theneo/quickstart/editor/web-editor-widgets/request-widget" target="_self">here</a></p></div></div></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >2</h6><h3 class="slate-h3 " >Selecting Your AI Co-Pilot</h3><p class="slate-p " >Once your API specification is uploaded, you can harness the power of Theneo&apos;s AI Co-pilot to enrich your content. Decide whether you want the AI to fully generate the content, enhance what you&apos;ve already created, or if you prefer to proceed without AI assistance. If you&apos;re looking to streamline the setup, simply click on &quot;Quick Start&quot; to bypass the customization and move directly to publishing.</p><p class="slate-p " ></p><div style="text-align:center"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/88b6be9d-6320-4270-a4b6-675e6aa1e8f5.png" style="
              width:804px;
	            height:297px;
	            aspect-ratio:804 / 297"
         /></div></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >3</h6><h3 class="slate-h3 " >Setting Permissions and Fine-Tuning Your Project</h3><p class="slate-p " >Set your project’s visibility and invite collaborators according to your workflow needs. With Theneo, you can start with a private project and go public when you&apos;re ready, seamlessly inviting others to contribute. Manage these settings at any time to fit your project’s development lifecycle.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><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 " >You can change project level permission and even set up advanced access management later in the project settings.</p></div></div></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >4</h6><h3 class="slate-h3 " >Publish</h3><p class="slate-p slate-indent-0" style="0px">Utilize Theneo&apos;s editing suite for final adjustments before publishing. Preview to ensure everything is perfect and publish to make your documentation available to users. It’s documentation made simple, yet powerful and comprehensive</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >5</h6><h3 class="slate-h3 " >Optional steps:</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><a href="https://app.theneo.io/theneo/quickstart/editor/web-editor-widgets" target="_top">Edit the project </a></div></li><li class="slate-li " ><div style="position:relative"><a href="https://app.theneo.io/theneo/quickstart/editor/preview-changes" target="_top">Preview the project before publishing </a></div></li><li class="slate-li " ><div style="position:relative"><a href="https://app.theneo.io/theneo/quickstart/automation-and-dev-tools" target="_top">Automate the flow</a></div></li><li class="slate-li " ><div style="position:relative"><a href="https://app.theneo.io/theneo/quickstart/ai-co-pilot-and-chat/ai-chat-chatgpt" target="_top">AI search </a></div></li></ul></div></div></div><p class="slate-p " ></p>

Creating intuitive, detailed, and easy-to-navigate API documentation has never been easier. Theneo streamlines every step of the process, ensuring that your documentation is not only comprehensive but also interactive and user-friendly. Here's how you can quickly set up your project in Theneo

When you log into Theneo, start by adding a new project from the homepage. Your project could be an API reference, a developer guide, or any type of documentation you need. Give your project a title, select the appropriate workspace, and you're on your way. For detailed instructions on workspaces, check out our guides

<p>Theneo provides a robust and versatile range of API formats and collection types to cater to a wide array of integration and development needs. Our platform supports various API formats, including REST, SOAP, GraphQL, and Async APIs, each tailored to different use cases and requirements. Additionally, we offer compatibility with multiple API specification collections, ensuring seamless integration and a streamlined development process. Below is an overview of the supported f</p>

Theneo provides a robust and versatile range of API formats and collection types to cater to a wide array of integration and development needs. Our platform supports various API formats, including REST, SOAP, GraphQL, and Async APIs, each tailored to different use cases and requirements. Additionally, we offer compatibility with multiple API specification collections, ensuring seamless integration and a streamlined development process. Below is an overview of the supported formats and collections:


In the following sections, we'll delve into each of these formats and collections, providing detailed insights and instructions.

<p>Theneo’s API Explorer is an interactive tool that significantly simplifies the API testing process. It allows users to engage with their APIs in real-time, providing an immersive experience that bridges the gap between technical understanding and practical application. Whether you're a developer or a non-technical user, the API Explorer is designed to offer a seamless and intuitive way to explore and validate API functionality.</p><div></div>

Theneo’s API Explorer is an interactive tool that significantly simplifies the API testing process. It allows users to engage with their APIs in real-time, providing an immersive experience that bridges the gap between technical understanding and practical application. Whether you're a developer or a non-technical user, the API Explorer is designed to offer a seamless and intuitive way to explore and validate API functionality.

<p class="slate-p " >Theneo’s Changelog is an essential tool for developers and stakeholders to track changes and updates to your API specifications. This powerful feature not only documents all modifications automatically but also provides an option for users to subscribe and receive email notifications for each update.</p><p class="slate-p " ></p><div style="text-align:center"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/8a7be86e-d55b-4859-b60f-b6292c22e06b.png" style="
              width:860px;
	            height:455px;
	            aspect-ratio:860 / 455"
         /></div><h3 class="slate-h3 " >Automated Changelog Documentation</h3><p class="slate-p " >Whenever a new API spec is imported and the &quot;Publish&quot; button is clicked, Theneo detects and summarizes all the changes, such as:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">New endpoints added</div></li><li class="slate-li " ><div style="position:relative">Existing sections updated</div></li><li class="slate-li " ><div style="position:relative">Descriptions modified</div></li><li class="slate-li " ><div style="position:relative">Sections or endpoints removed</div></li></ul><p class="slate-p " >These updates are meticulously logged on a dedicated changelog page, providing a detailed version history with timestamps.</p><h3 class="slate-h3 " >Real-Time Email Notifications</h3><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">How to Subscribe</strong></p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Enter Your Email</strong></span>: On the Changelog page, there’s a field to enter your email.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Hit Subscribe</strong></span>: Click the “Subscribe” button to start receiving updates on the documentation changes.</div></li></ol><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Benefits of Subscription</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Immediate Awareness</strong></span>: Get notified as soon as changes are published, allowing for prompt action or adaptation in your workflow.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Convenient Overviews</strong></span>: Email notifications provide a summary of the changes, making it easier to stay informed without needing to check the changelog manually.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Version Tracking</strong></span>: Keep a close eye on version progression and ensure that all team members and API consumers are aligned with the latest API developments.</div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " >FAQ</h3><p class="slate-p " ><strong class="slate-bold">Can I turn off the changelog?</strong></p><p class="slate-p " >Yes, the changelog feature in Theneo is optional. You can disable it at any time by going to your project settings, navigating to the &apos;Features&apos; section, and toggling off the changelog feature.</p><p class="slate-p " ><strong class="slate-bold">Can I edit the changelog?</strong></p><p class="slate-p " >Currently, direct editing of changelog entries is not available. However, if you need to remove a specific entry from the public changelog, you can delete it. To do this, go to your project configuration, select &apos;Public Changelog,&apos; and use the delete button next to the entry you wish to remove.</p><p class="slate-p " ><strong class="slate-bold">Can I edit versions?</strong></p><p class="slate-p " >The ability to edit version details is a feature that is in the pipeline and will be available soon. This upcoming feature will provide more control over how you document and present version changes in the changelog.</p><p class="slate-p " ><strong class="slate-bold">Will this create a new API version if there are breaking changes?</strong></p><p class="slate-p " >Theneo is designed to track changes meticulously. The functionality to automatically create a new API version upon detecting breaking changes is being developed. When released, it will allow users to manage versions more effectively and ensure that versioning reflects significant changes or updates.</p><p class="slate-p " ></p><p class="slate-p " ></p>

Theneo’s Changelog is an essential tool for developers and stakeholders to track changes and updates to your API specifications. This powerful feature not only documents all modifications automatically but also provides an option for users to subscribe and receive email notifications for each update.

Whenever a new API spec is imported and the "Publish" button is clicked, Theneo detects and summarizes all the changes, such as:

These updates are meticulously logged on a dedicated changelog page, providing a detailed version history with timestamps.

Yes, the changelog feature in Theneo is optional. You can disable it at any time by going to your project settings, navigating to the 'Features' section, and toggling off the changelog feature.

Currently, direct editing of changelog entries is not available. However, if you need to remove a specific entry from the public changelog, you can delete it. To do this, go to your project configuration, select 'Public Changelog,' and use the delete button next to the entry you wish to remove.

The ability to edit version details is a feature that is in the pipeline and will be available soon. This upcoming feature will provide more control over how you document and present version changes in the changelog.

Will this create a new API version if there are breaking changes?

Theneo is designed to track changes meticulously. The functionality to automatically create a new API version upon detecting breaking changes is being developed. When released, it will allow users to manage versions more effectively and ensure that versioning reflects significant changes or updates.

<p>API versioning in Theneo is designed to be both intuitive and comprehensive, accommodating the natural evolution of your APIs. With Theneo, you can manage and track incremental changes within the same version using the API changelog, as well as create and oversee major version transitions such as moving from v1 to v2 or v3.</p><p>Theneo now offers a feature for comprehensive API version management. This feature enables users to meticulously handle different</p>

API versioning in Theneo is designed to be both intuitive and comprehensive, accommodating the natural evolution of your APIs. With Theneo, you can manage and track incremental changes within the same version using the API changelog, as well as create and oversee major version transitions such as moving from v1 to v2 or v3.

Theneo now offers a feature for comprehensive API version management. This feature enables users to meticulously handle different versions of their API, such as v2, v3, and beyond, each with unique statuses and configurations.

As this is a beta feature, Theneo invites users to activate API versioning by reaching out to us:

Once API versioning is enabled for your account, you can:

For more information on API versioning and to request access to this beta feature, please contact us at 

. We are committed to supporting you in leveraging this feature to its full potential, ensuring effective management of your API's lifecycle.

<p>A project in Theneo is a robust toolset that allows you to create and manage a wide array of technical content. This can range from API references, SDK documentation, product guides, and much more. Theneo provides an easy and streamlined way to generate API documentation from API collections, allowing you to focus on delivering high-quality, accurate, and up-to-date content.</p><p>To create your first projec</p>

A project in Theneo is a robust toolset that allows you to create and manage a wide array of technical content. This can range from API references, SDK documentation, product guides, and much more. Theneo provides an easy and streamlined way to generate API documentation from API collections, allowing you to focus on delivering high-quality, accurate, and up-to-date content.

To create your first project with Theneo:

Editing the generated content or adding new content is a breeze, thanks to Theneo’s intuitive, Notion-like editor. You can easily tweak API requests, methods, properties, descriptions, responses, and much more. 

Once you're satisfied with your API reference, the next step is to publish your project. However, it's always a good practice to preview your changes before hitting the publish button.

Here's how you can preview, publish, and share your project:

<p>Theneo's web editor is a rich and intuitive platform, equipped with a variety of widgets that enrich the documentation experience. These widgets add depth and clarity to your API documentation, making it more engaging and informative. You can easily access these widgets by simply going to a new line in the editor and typing <span><code><strong>/</strong></code></span>, which brings up the widget options</p>

Theneo's web editor is a rich and intuitive platform, equipped with a variety of widgets that enrich the documentation experience. These widgets add depth and clarity to your API documentation, making it more engaging and informative. You can easily access these widgets by simply going to a new line in the editor and typing 

, which brings up the widget options. Let's take a look at the widgets available:

: A simple yet effective tool to create clear separations between sections, enhancing readability and structure.

: Draws focus to important information, tips, or warnings, ensuring key messages are not missed.

: Ideal for presenting data or information systematically, making complex details easier to digest.

: Brings your documentation to life with visual content like diagrams, screenshots, or explanatory videos, offering a richer understanding.

Enables users to define API endpoints, manage request and response parameters, and configure essential details like data types, keys, values, and descriptions, ensuring accurate API setup and functionality.

: Perfect for displaying code snippets, helping users understand implementation details in different programming languages.

: Shows practical examples of objects used in your API, demystifying complex data structures for better comprehension.

: Outlines potential errors that might occur, providing a guide for troubleshooting and error resolution.

: Clarifies the HTTP status codes your API returns, giving insights into various responses and their meanings.

: Displays the base URL of your API prominently, a crucial starting point for users making API requests.

: Allows for multi-language documentation, offering code examples in various programming languages to cater to a diverse audience.

Provides a concise overview of all API endpoints from different subsections in one place. It allows users to easily navigate to specific endpoints by clicking on them within the widget, offering a quick and seamless way to access detailed endpoint information.

Each widget is tailored to enhance specific aspects of API documentation, making Theneo's web editor a versatile tool for developers and technical writers. As you proceed with documentation, these widgets can be seamlessly integrated to cater to your content needs, ensuring a comprehensive and user-friendly experience.

<p class="slate-p " >We know, great collaboration leads to great results, and the <strong class="slate-bold">Live Collaboration</strong> feature in our editor ensures that your team can work together in real-time to achieve just that. Whether you're working on documentation or complex projects, this feature allows multiple users to make updates simultaneously, ensuring everyone is on the same page and contributing effectively. With real-time visibility into who’s editing what, collaboration becomes smooth, organized, and more productive.</p><p class="slate-p " ></p><div style="text-align:center"><a href="https://theneo-prod-public.s3.us-east-1.amazonaws.com/bf2ffa51-a5d2-48c1-9840-62862bbedb7e.png" target="_blank" rel="noreferrer"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/bf2ffa51-a5d2-48c1-9840-62862bbedb7e.png" style="width:774px;
	  height:581px;
	  aspect-ratio:774 / 581" /></a></div><p class="slate-p " ></p><h4 class="slate-h4 " >Key Features of Live Collaboration</h4><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">See Who’s Currently Editing a Section</strong>: At any point during the editing process, users can see which collaborators are actively editing a particular section. This visibility helps avoid confusion or duplication of work and ensures smooth collaboration among team members.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">View Where Others Are Editing</strong>: Within a section, users can see exactly where their collaborators are making changes in real-time. The editor highlights the text being edited by another user, giving you immediate feedback on what is being updated.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Cursor Visibility</strong>: For greater clarity, the cursor of the collaborator is visible within the section description. This allows users to pinpoint the exact location where edits are happening, ensuring that changes are made in the correct area.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">See Who’s Editing Which Section in the Menu</strong>:The menu provides an overview of who is editing which section. Each section that is being actively worked on by a user is marked with their name, making it easy to track where collaborators are focused. This feature enhances coordination, especially in larger documents with multiple sections.</div></li></ol><h4 class="slate-h4 " >How to Use Live Collaboration</h4><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Start Editing Together</strong>: Once users are invited to collaborate on a project or document, they can begin editing simultaneously. As soon as one user starts editing a section, others will see their presence and activity in real-time.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Communicate with Collaborators</strong>: Although the collaboration feature does not include a built-in chat, the real-time presence indicators allow for smooth coordination. Teams can also supplement this feature with external communication tools to enhance collaboration further.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Conflict Avoidance</strong>: Since all users can see who is editing a section, this minimizes the risk of conflicting edits. It helps maintain organized teamwork and ensures that changes are consolidated without accidental overwrites.</div></li></ul><p class="slate-p " ></p>

We know, great collaboration leads to great results, and the 

 feature in our editor ensures that your team can work together in real-time to achieve just that. Whether you're working on documentation or complex projects, this feature allows multiple users to make updates simultaneously, ensuring everyone is on the same page and contributing effectively. With real-time visibility into who’s editing what, collaboration becomes smooth, organized, and more productive.

<p class="slate-p " >In Theneo, users can switch to <strong class="slate-bold">Preview Mode</strong> at any time while editing to review the latest changes before publishing. This feature offers several key benefits:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Accurate Rendering</strong>: Preview Mode allows you to see exactly how your content will appear in the final published documentation. This helps ensure that all formatting, layout, and design elements are rendering as intended.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Section-Specific Previews</strong>: You can preview changes for individual sections, ensuring that every detail is correct before publishing. This is especially useful when working on larger documents with multiple sections.</div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " >How to Use Preview Mode</h3><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Locate the Switcher Button</strong>: In the editor’s header, you’ll find the <strong class="slate-bold">Editor/Preview</strong> switcher button. This is your key to moving between edit mode and preview mode effortlessly.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Switch to Preview Mode</strong>: When you're ready to preview your content, click on the switcher to enter <strong class="slate-bold">Preview Mode</strong>. This will display the most recent version of your documentation as it will appear to end users.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Preview Specific Sections</strong>: You can preview any section of your document to see how changes to that section look. </div></li></ol><p class="slate-p " >If the preview meets your expectations, you can move forward by selecting the <strong class="slate-bold">Publish</strong> option. Once confirmed, your documentation will go live with all the updates and enhancements you've applied.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><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 " ><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Note:</strong></span> Preview mode is a visualization tool to give you a sense of your project's design and layout. It may not represent the full interactivity of your live documentation, such as functional API explorers or live code examples. Use this mode to make any final adjustments before updating your live documentation.</p></div></div><p class="slate-p " ></p><p class="slate-p " ></p>

 at any time while editing to review the latest changes before publishing. This feature offers several key benefits:

If the preview meets your expectations, you can move forward by selecting the 

 option. Once confirmed, your documentation will go live with all the updates and enhancements you've applied.

<p class="slate-p " ><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Step 1: Create Theneo Documentation</strong></span></p><p class="slate-p " >Begin by creating a documentation project within Theneo to house your API details.</p><p class="slate-p " ><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Step 2: </strong></span><a href="https://github.com/marketplace/actions/theneo-api-documentation" target="_self"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Set Up GitHub Workflow</strong></span></a></p><p class="slate-p " >Configure a workflow in your <a href="https://github.com/marketplace/actions/theneo-api-documentation" target="_self">GitHub</a> repository that will interact with Theneo:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Create a Workflow File</strong></span>: Add a file named <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">Theneo.yml</strong></code></span> to the <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">.github/workflows/</strong></code></span> directory in your GitHub repository. This file will define the actions to be taken.</div></li></ul><p class="slate-p " ><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Example </strong></span><span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">Theneo.yml</strong></code></span><span style="color:var(--tw-prose-bold)"><strong class="slate-bold"> Workflow</strong></span>:</p><div class="code-block-wrapper"  style="width:60%" ><div class="code-block-header">YAML</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-yaml keep-markup drop-tokens"><div class="slate-code_line">codename: Update Documentation</div><div class="slate-code_line">on:</div><div class="slate-code_line">  pull_request:</div><div class="slate-code_line">    branches:</div><div class="slate-code_line">      - main</div><div class="slate-code_line">jobs:</div><div class="slate-code_line">  update-doc:</div><div class="slate-code_line">    name: Update Theneo Documentation</div><div class="slate-code_line">    runs-on: ubuntu-latest</div><div class="slate-code_line">    steps:</div><div class="slate-code_line">      - run: echo &quot;🎉 The job was automatically triggered by a ${{ github.event_name }} event.&quot;</div><div class="slate-code_line">      - name: Checkout</div><div class="slate-code_line">        uses: actions/checkout@v4</div><div class="slate-code_line">      - name: Setup Node.js</div><div class="slate-code_line">        uses: actions/setup-node@v4</div><div class="slate-code_line">        with:</div><div class="slate-code_line">          node-version: &quot;18&quot;</div><div class="slate-code_line">      - name: Update Documentation on Theneo</div><div class="slate-code_line">        uses: Theneo-Inc/api-documentation@1.8.0</div><div class="slate-code_line">        with:</div><div class="slate-code_line">          FILE_PATH: doc/api.yml</div><div class="slate-code_line"></div><div class="slate-code_line">          PROJECT_SLUG: &lt;project_slug&gt;</div><div class="slate-code_line">          VERSION_SLUG: &lt;version_slug&gt;</div><div class="slate-code_line">          WORKSPACE_SLUG: &lt;workspace_slug&gt;</div><div class="slate-code_line"></div><div class="slate-code_line">          SECRET: ${{secrets.SECRET}}</div><div class="slate-code_line"></div><div class="slate-code_line">          AUTO_PUBLISH: true</div><div class="slate-code_line"></div><div class="slate-code_line">          IMPORT_OPTION: merge</div><div class="slate-code_line">          PARAMETER_DESCRIPTION_MERGE_STRATEGY: keep_new</div><div class="slate-code_line">          SECTION_DESCRIPTION_MERGE_STRATEGY: keep_old</div><div class="slate-code_line"></div><div class="slate-code_line">          INCLUDE_GITHUB_METADATA: true</div><div class="slate-code_line"></div></code></pre></div><h3 class="slate-h3 " >Locating Your Theneo Project Slug</h3><p class="slate-p " >To configure GitHub Actions, you&apos;ll need your Theneo project slug:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Go to your project dashboard in Theneo.</div></li><li class="slate-li " ><div style="position:relative">Open the desired project.</div></li><li class="slate-li " ><div style="position:relative">The project slug is part of the URL: <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">https://app.theneo.io/&lt;workspace-name&gt;/&lt;project-slug&gt;/[version-slug]</strong></code></span>.</div></li><li class="slate-li " ><div style="position:relative">For example, if the URL is <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">https://app.theneo.io/theneo/github-demo</strong></code></span>, your project slug is <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">github-demo</strong></code></span>.</div></li></ul><p class="slate-p " >Use this project slug for the <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">PROJECT_SLUG</strong></code></span> variable in your GitHub workflow.

Inputs</p><p class="slate-p " >Define the following inputs in your workflow file to configure the GitHub Action:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">FILE_PATH</strong></code></span>: The path to your API documentation file within the repository.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">PROJECT_SLUG</strong></code></span>: Your project&apos;s unique identifier in Theneo, accessible under project settings.</div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">VERSION_SLUG</code>: Project version slug to import documentation under a specific version, otherwise default version will be used.</div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">WORKSPACE_SLUG</code>: Project workspace slug to import documentation under specific workspace.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">SECRET</strong></code></span>: Your Theneo API token for authentication, which can be found in your Theneo profile.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">IMPORT_OPTION</strong></code></span>: Determines how to handle the imported documentation. Options include <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">overwrite</strong></code></span>, <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">merge</strong></code></span>, and <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">endpoints</strong></code></span>.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">AUTO_PUBLISH</strong></code></span>: If set to <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">true</strong></code></span>, Theneo will automatically publish the changes. If <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">false</strong></code></span>, you can review changes in the editor before manual publication.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">INCLUDE_GITHUB_METADATA</strong></code></span>: Includes metadata like the GitHub actor in the documentation, visible only in Theneo&apos;s editor.</div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">SECTION_DESCRIPTION_MERGE_STRATEGY</code> : Merging 
strategy for section descriptions to keep old descriptions from theneo 
editor if needed, valid values are keep_new or keep_old.</div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">PARAMETER_DESCRIPTION_MERGE_STRATEGY</code>: 
Merging strategy for parameter descriptions to keep old descriptions 
from theneo editor if needed, valid values are keep_new or keep_old.</div></li></ul><h3 class="slate-h3 " >Import Options</h3><p class="slate-p " >Choose how Theneo handles incoming changes:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">overwrite</strong></code></span>: Replaces the current documentation with the new spec entirely.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">merge</strong></code></span>: Attempts to merge changes; this is experimental and may append changes in some cases.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">endpoints</strong></code></span>: Adds new spec endpoints into a dedicated section for manual arrangement.</div></li></ul><h3 class="slate-h3 " >Auto-Publish Option</h3><p class="slate-p " >Control the publication of your documentation:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">true</strong></code></span>: Automatically updates the published documentation with the latest changes.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">false</strong></code></span>: Allows for a review in Theneo&apos;s editor before you decide to publish.</div></li></ul><p class="slate-p " >Using Theneo&apos;s GitHub Actions integration, the process of maintaining accurate and current API documentation becomes automated, seamless, and efficient. Your team and users gain immediate access to the latest documentation, ensuring everyone is on the same page with API updates and changes.</p><p class="slate-p " ></p>

Begin by creating a documentation project within Theneo to house your API details.

 repository that will interact with Theneo:

To configure GitHub Actions, you'll need your Theneo project slug:

 variable in your GitHub workflow.

Inputs

Define the following inputs in your workflow file to configure the GitHub Action:

Choose how Theneo handles incoming changes:

Control the publication of your documentation:

Using Theneo's GitHub Actions integration, the process of maintaining accurate and current API documentation becomes automated, seamless, and efficient. Your team and users gain immediate access to the latest documentation, ensuring everyone is on the same page with API updates and changes.

<p class="slate-p " >Visual Studio Code (VS Code) is a preferred editor for many developers due to its versatility and extensive extension ecosystem. To enhance the experience further, Theneo offers a dedicated VS Code extension that simplifies the creation and previewing of API references directly within the editor.</p><h2 class="slate-h2 " >Installation and Configuration</h2><p class="slate-p " ><strong class="slate-bold">⬇️</strong><a href="undefined" target="_blank"><strong class="slate-bold"> </strong></a><a href="undefined" target="_blank"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Install the Theneo VS Code Extension</strong></span></a></p><p class="slate-p " ></p><p class="slate-p " ><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Configure the Extension</strong></span>:</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">After installation, sign in to your Theneo account at <a href="https://app.theneo.io/theneo-branding/vs-code-extension/app.theneo.io" target="_blank">app.theneo.io</a></div></li><li class="slate-li " ><div style="position:relative">Once signed in, navigate to your profile settings.</div></li><li class="slate-li " ><div style="position:relative">Within your profile settings, locate and select the "Tools & Integrations" section.</div></li><li class="slate-li " ><div style="position:relative">In the "Tools & Integrations" section, find and copy your Theneo API key.</div></li><li class="slate-li " ><div style="position:relative">In VS Code Extension open the command palette by pressing <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">Ctrl+Shift+P</strong></code></span> (or <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">Cmd+Shift+P</strong></code></span> on Mac).</div></li><li class="slate-li " ><div style="position:relative">Type 'Preferences: Open Settings (UI)' and select it.</div></li><li class="slate-li " ><div style="position:relative">Search for Theneo Markdown in the “Extensions” section</div></li><li class="slate-li " ><div style="position:relative">Paste your Theneo API key</div></li></ol><p class="slate-p " ></p><h3 class="slate-h3 " ><strong class="slate-bold">New Features</strong></h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Ability to export projects from Theneo as markdown and json.</div></li><li class="slate-li " ><div style="position:relative">Ability to Import markdown into theneo directly.</div></li><li class="slate-li " ><div style="position:relative">Ability to merge json to an existing project in Theneo.</div></li></ul><h3 class="slate-h3 " ><strong class="slate-bold">
Usage
</strong></h3><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Export Project from Theneo</strong></p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Open the command palette by pressing Ctrl+Shift+P (or Cmd+Shift+P on Mac).</div></li><li class="slate-li " ><div style="position:relative">Search for “Theneo: Export Project from Theneo”.</div></li><li class="slate-li " ><div style="position:relative">Select the project from your list of published projects created in Theneo.</div></li><li class="slate-li " ><div style="position:relative">Enter a parent directory to export the project and press enter.</div></li></ol><p class="slate-p slate-indent-0" style="0px"></p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Import Project to Theneo</strong></p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Open the command palette by pressing Ctrl+Shift+P (or Cmd+Shift+P on Mac).</div></li><li class="slate-li " ><div style="position:relative">Search for “Theneo: Import Project To Theneo”.</div></li><li class="slate-li " ><div style="position:relative">Enter project name after “/”. example <code class="slate-code">/project</code></div></li><li class="slate-li " ><div style="position:relative">Choose if you want to publish the document.</div></li></ol><p class="slate-p " ></p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Merge Project to Theneo</strong></p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Open the command palette by pressing Ctrl+Shift+P (or Cmd+Shift+P on Mac).</div></li><li class="slate-li " ><div style="position:relative">Search for "Theneo: Merge Project To Theneo".</div></li><li class="slate-li " ><div style="position:relative">Copy the relative path to the section that you want to merge.</div></li><li class="slate-li " ><div style="position:relative">Pick the project you are merging with (usually the same project as you exported).</div></li><li class="slate-li " ><div style="position:relative">Go over the changes and press commit merge button.</div></li></ol><p class="slate-p " ></p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Open Preview</strong></p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Open the command palette by pressing Ctrl+Shift+P (or Cmd+Shift+P on Mac).</div></li><li class="slate-li " ><div style="position:relative">Search for “Theneo: Open Current Project Preview”.</div></li><li class="slate-li " ><div style="position:relative">Type the project name and press enter.</div></li></ol><p class="slate-p slate-indent-0" style="0px">The Theneo VS Code extension streamlines the API documentation process by integrating it into your development environment. It saves time and enhances efficiency by eliminating the need to switch between tools for documentation tasks.</p><p class="slate-p slate-indent-0" style="0px">
With just a few clicks, you can generate a live preview of your API documentation, making it easier to develop and review your API descriptions and endpoints without ever leaving VS Code.</p><p class="slate-p " ></p><p class="slate-p " ></p>

Visual Studio Code (VS Code) is a preferred editor for many developers due to its versatility and extensive extension ecosystem. To enhance the experience further, Theneo offers a dedicated VS Code extension that simplifies the creation and previewing of API references directly within the editor.

The Theneo VS Code extension streamlines the API documentation process by integrating it into your development environment. It saves time and enhances efficiency by eliminating the need to switch between tools for documentation tasks.


With just a few clicks, you can generate a live preview of your API documentation, making it easier to develop and review your API descriptions and endpoints without ever leaving VS Code.

The Theneo CLI (Command Line Interface) is s a command-line tool for effortless management of the Theneo platform from your terminal. Create, manage, and publish API documentation with ease, all without leaving your command line.

 or the npm package here →  https://www.npmjs.com/package/@theneo/cli 

To install the Theneo CLI, use the following command:

This command installs the Theneo CLI globally on your machine, allowing it to be run from any directory.

To get started with Theneo CLI, you can use the 

This command provides a list of available options and commands:

Creating a Project with an API Spec File:

Creating a Project Using a Link to API Documentation:

Creating a Project from Postman Collections:

3. Updating API Documentation from an API Spec File


9. Export project data in Markdown format  - Beta


10. Import project data from Markdown files

11. Exporting an OpenAPI Spec  - Beta feature

You can export your Theneo docs into an openAPI spec, by running the following command

You can use the same exporting options as in the regular export command. 

12. Create a new project from markdown files

The Theneo SDK is a comprehensive package designed to simplify API requests to the Theneo API, enabling easy integration of Theneo's features into various applications. This SDK abstracts the complexities of API requests and error handling, providing a more streamlined experience for developers.

This documentation provides an overview of the Theneo SDK package. The SDK package includes classes and interfaces for working with the Theneo API. Theneo is a platform for managing API documentation projects.

Install the Theneo SDK Package: Use npm to install the Theneo SDK package:

To use the Theneo SDK package, import the necessary classes and interfaces, and create an instance of the 

 class with the required options. Then, you can use the methods provided by the SDK to interact with the Theneo API.

An example demonstrating how to use the 

 method to import API documentation to an existing project using the Theneo SDK in TypeScript:

Make sure to replace the placeholder values (

, and any others) with your actual API key and project details before running the code.

The main class for interacting with the Theneo API.

An enum representing different types of description generation options.

DescriptionGenerationProgressHandler (Type)

A callback function type that receives the progress percentage of description generation.

Options for importing Postman collections.

Workspace options for creating a project.

Data input options for creating a project. Specify only one of the following attributes.

An enum representing different options for importing API specifications.

Options for importing API documentation to an existing project.

A response object after publishing a project.

A schema representing company information.

A schema representing project information.

Options for creating other types of documentation.

An enum representing different statuses for a created project.

A response object after creating a project.

ProjectCreationStatusResponse (Interface)

A response object containing information about the status of project creation.

A response object after importing a project.

An enum representing different user roles.

An abstract class representing the result of an operation that can either succeed with a value of type 

A class representing a successful result.

A function for creating a successful result.

An interface representing the schema of a response object.

<p>Bitbucket’s collaborative environment is ideal for teams to manage their codebase. Integrating Bitbucket with Theneo ensures your API documentation stays in sync with your repository changes. Here’s how to set up Bitbucket integration:</p><h2>Usage</h2><p><span><strong>Step 1: Create Theneo Documentation</strong></span></p><p>Initiate your API documentation by creatin</p>

Bitbucket’s collaborative environment is ideal for teams to manage their codebase. Integrating Bitbucket with Theneo ensures your API documentation stays in sync with your repository changes. Here’s how to set up Bitbucket integration:

Initiate your API documentation by creating a project on the Theneo platform.

Incorporate Theneo's automation into your Bitbucket repository:

After setting up the Bitbucket pipeline with the appropriate Theneo variables, your API documentation will automatically reflect changes pushed to your repository. This seamless integration facilitates an up-to-date and accurate representation of your API for developers and stakeholders.

<p>Theneo's AI CoPilot revolutionizes the way API documentation is created by automating the generation and enhancement of content. With options for full AI assistance, enhancing existing content, or opting out, it provides a flexible approach to building comprehensive documentation. The AI CoPilot functions as an expert technical writer, offering precise descriptions for parameters, ensuring consistency and reducing manual effort.</p>

Theneo's AI CoPilot revolutionizes the way API documentation is created by automating the generation and enhancement of content. With options for full AI assistance, enhancing existing content, or opting out, it provides a flexible approach to building comprehensive documentation. The AI CoPilot functions as an expert technical writer, offering precise descriptions for parameters, ensuring consistency and reducing manual effort.

The integration of ChatGPT brings interactive, conversational AI to Theneo's documentation, allowing users to ask questions directly within the docs. This feature, powered by the sophisticated GPT-4 turbo, is easily enabled in settings and offers users instant, contextual answers to both technical and business inquiries, elevating the documentation's utility and user engagement.

Together, Theneo's AI CoPilot and ChatGPT integration deliver a dynamic duo of content generation and user interaction, simplifying the documentation process and enhancing the end-user experience.

<p>Craft a distinctive look and feel for your Theneo documentation with extensive branding and styling customization options. From choosing the right color palette to setting a custom domain, Theneo empowers you to align your documentation with your brand identity.</p><p>
</p><div></div>

Craft a distinctive look and feel for your Theneo documentation with extensive branding and styling customization options. From choosing the right color palette to setting a custom domain, Theneo empowers you to align your documentation with your brand identity.

With Theneo's customization tools, you can create documentation that not only serves its purpose but also resonates with your brand's aesthetic and ethos, making every interaction with your API an extension of your brand experience.

<p>A Developer Portal, also known as a Developer Hub, is a centralized platform designed to facilitate and manage the interaction between an organization and its developer community. It serves as a comprehensive resource for all things related to an organization's APIs or development tools, providing necessary documentation, API keys, resources, support, and community discussions.</p><p></p><div></div>

A Developer Portal, also known as a Developer Hub, is a centralized platform designed to facilitate and manage the interaction between an organization and its developer community. It serves as a comprehensive resource for all things related to an organization's APIs or development tools, providing necessary documentation, API keys, resources, support, and community discussions.

Key features of Theneo's Developer Portal include:

<h3>What are Workspaces?</h3><p>Workspaces in Theneo are distinct areas within the platform designed to manage different projects or teams under one umbrella organization. They serve as separate containers that allow for distinct management of APIs, documentation, and team access. Each workspace can have its own branding, permissions, and configurations, making it an ideal solution for companies with multiple products or teams.</p><h3>Benef</h3>

Workspaces in Theneo are distinct areas within the platform designed to manage different projects or teams under one umbrella organization. They serve as separate containers that allow for distinct management of APIs, documentation, and team access. Each workspace can have its own branding, permissions, and configurations, making it an ideal solution for companies with multiple products or teams.

In summary, workspaces in Theneo provide a powerful means to segment and manage your API documentation and teams. They offer the flexibility to support multiple products, brands, and teams within a single platform, ensuring that each can operate with its required level of autonomy and specificity

<p class="slate-p " >Theneo's flexible documentation platform supports not only API documentation but also a wide variety of content types, including comprehensive user and product guides. This flexibility enables you to create rich, informative content tailored to your audience's needs, whether they are developers, product managers, or end-users.</p><p class="slate-p " ></p><div style="text-align:center"><a href="https://theneo-prod-public.s3.us-east-1.amazonaws.com/10a4a8ca-04e4-46b1-9506-6b74c8b933fe.png" target="_blank" rel="noreferrer"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/10a4a8ca-04e4-46b1-9506-6b74c8b933fe.png" style="width:933px;
	  height:530px;
	  aspect-ratio:933 / 530" /></a></div><h3 class="slate-h3 " >Getting Started with Guides</h3><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Initiate a New Project</strong></span>:</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Navigate to the "Create New Project" area.</div></li><li class="slate-li " ><div style="position:relative">Select "Other documentation" to branch out beyond API docs.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Choose a Template</strong></span>:</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Pick from a range of predefined templates like "Getting started guide", "SDK documentation", or "FAQ" for a quick start.</div></li><li class="slate-li " ><div style="position:relative">Opt for a "Blank" template for full creative control from scratch.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Customize Your Content</strong></span>:</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Use Theneo’s editor to add various content elements and structure your guide.</div></li><li class="slate-li " ><div style="position:relative">Include text, images, videos, and more to make your guide engaging and helpful.</div></li></ul></li></ol><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Theneo's flexible documentation platform supports not only API documentation but also a wide variety of content types, including comprehensive user and product guides. This flexibility enables you to create rich, informative content tailored to your audience's needs, whether they are developers, product managers, or end-users.

<p class="slate-p " ></p><h3 class="slate-h3 " ><strong class="slate-bold">How do I delete parameter?</strong></h3><p class="slate-p slate-indent-0" style="0px">To delete a parameter, follow these steps:</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Switch to the code view mode in the widget.</div></li><li class="slate-li " ><div style="position:relative">Select the parameter you wish to delete.</div></li><li class="slate-li " ><div style="position:relative">Proceed with the deletion.</div></li></ol><div style="text-align:center"><iframe
                        title="embed"
                        frameBorder="0"
                        allowFullScreen=""
                        src="https://player.vimeo.com/video/929688288"
                        id="929688288"
                        provider="vimeo"
                        class="slate-MediaEmbedElement-iframe"
                        width="46.827411167512686%"
                    ></iframe></div><h3 class="slate-h3 " ><strong class="slate-bold">How can I delete my Theneo account?</strong></h3><p class="slate-p slate-indent-0" style="0px">To permanently remove your account and all associated data, please contact our support team directly at hello@theneo.io. A support representative will guide you through the secure account deletion process.</p><p class="slate-p " ></p><h3 class="slate-h3 " ><strong class="slate-bold">
How can I create a workspace?</strong></h3><p class="slate-p slate-indent-0" style="0px">You can create a workspace in Theneo using one of the following methods:</p><p class="slate-p slate-indent-0" style="0px">If the corporate workspace toggle is enabled during sign-up, you can:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Join an existing corporate workspace associated with your corporate domain.</div></li><li class="slate-li " ><div style="position:relative">Create your own corporate workspace.</div></li></ul><p class="slate-p " >If the corporate workspace toggle is disabled during sign-up, you will automatically be added to your personal workspace upon account creation.</p><p class="slate-p " >If you already have an account with a personal workspace, you can convert it to a corporate workspace:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Go to user settings -&gt; admin tab.</div></li><li class="slate-li " ><div style="position:relative">Select &quot;Convert as corporate&quot; option.</div></li><li class="slate-li " ><div style="position:relative">Name your workspace and confirm the conversion.</div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " ><strong class="slate-bold">
How can I link sections within my Theneo documentation?</strong></h3><p class="slate-p " >Here&apos;s how to achieve this:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Navigate to your published documentation and locate the section you want to link to.</div></li><li class="slate-li " ><div style="position:relative">Copy the URL displayed in your web browser&apos;s address bar for that specific section.</div></li></ul><p class="slate-p " >Switch to the editor view within your Theneo project.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Select the text you wish to convert into a hyperlink. This text will act as the clickable anchor point for your readers.</div></li><li class="slate-li " ><div style="position:relative">Locate the &quot;link&quot; option within the Theneo editor&apos;s formatting tools. </div></li><li class="slate-li " ><div style="position:relative">Paste the previously copied URL from step 1 into the designated field within the link creation menu.</div></li><li class="slate-li " ><div style="position:relative">Confirm the link creation by clicking &quot;Enter&quot;.</div></li></ul><p class="slate-p " >By following these steps, you&apos;ve successfully established a hyperlink within your Theneo documentation, allowing readers to navigate seamlessly between different sections.</p><p class="slate-p " ></p><h3 class="slate-h3 " ><strong class="slate-bold">
Can I update the auto-generated URL slug?</strong></h3><p class="slate-p " >Here&apos;s how to update the URL slugs:</p><p class="slate-p " >Project Slug:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Access your project settings.</div></li><li class="slate-li " ><div style="position:relative">Navigate to the &quot;General&quot; tab.</div></li><li class="slate-li " ><div style="position:relative">Locate the project slug setting and click on the edit icon.</div></li><li class="slate-li " ><div style="position:relative">Make your desired changes to the slug text.</div></li><li class="slate-li " ><div style="position:relative">Save your adjustments.</div></li></ul><p class="slate-p " >Section Slug:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Go to the &quot;SEO management&quot; section within your Theneo project.</div></li><li class="slate-li " ><div style="position:relative">Identify the specific section you want to modify the slug for.</div></li><li class="slate-li " ><div style="position:relative">Locate the edit option for the section&apos;s slug.</div></li><li class="slate-li " ><div style="position:relative">Update the slug text according to your preference.</div></li><li class="slate-li " ><div style="position:relative">Save your changes.</div></li></ul><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=warning ><div class="callout-icon"><svg width="18" height="16" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0.916637 15.5009C0.791637 15.5009 0.683998 15.4732 0.59372 15.4176C0.503443 15.362 0.430526 15.2857 0.37497 15.1884C0.319415 15.0912 0.288165 14.9905 0.28122 14.8864C0.274276 14.7822 0.305526 14.6745 0.37497 14.5634L8.4583 0.605103C8.52775 0.493991 8.60761 0.41413 8.69789 0.365519C8.78816 0.316908 8.88886 0.292603 8.99997 0.292603C9.11108 0.292603 9.21178 0.316908 9.30205 0.365519C9.39233 0.41413 9.47219 0.493991 9.54164 0.605103L17.625 14.5634C17.6944 14.6745 17.7257 14.7822 17.7187 14.8864C17.7118 14.9905 17.6805 15.0912 17.625 15.1884C17.5694 15.2857 17.4965 15.362 17.4062 15.4176C17.3159 15.4732 17.2083 15.5009 17.0833 15.5009H0.916637ZM1.99997 14.2509H16L8.99997 2.1676L1.99997 14.2509ZM9.0833 13.0634C9.26386 13.0634 9.41316 13.0044 9.53122 12.8864C9.64928 12.7683 9.7083 12.619 9.7083 12.4384C9.7083 12.2579 9.64928 12.1086 9.53122 11.9905C9.41316 11.8725 9.26386 11.8134 9.0833 11.8134C8.90275 11.8134 8.75344 11.8725 8.63539 11.9905C8.51733 12.1086 8.4583 12.2579 8.4583 12.4384C8.4583 12.619 8.51733 12.7683 8.63539 12.8864C8.75344 13.0044 8.90275 13.0634 9.0833 13.0634ZM9.0833 10.7509C9.26386 10.7509 9.41316 10.6919 9.53122 10.5739C9.64928 10.4558 9.7083 10.3065 9.7083 10.1259V6.70927C9.7083 6.52871 9.64928 6.37941 9.53122 6.26135C9.41316 6.1433 9.26386 6.08427 9.0833 6.08427C8.90275 6.08427 8.75344 6.1433 8.63539 6.26135C8.51733 6.37941 8.4583 6.52871 8.4583 6.70927V10.1259C8.4583 10.3065 8.51733 10.4558 8.63539 10.5739C8.75344 10.6919 8.90275 10.7509 9.0833 10.7509Z" fill="#F1C21B"></path></svg></div><div ><p class="slate-p " >Please note:  While customizing slugs is beneficial, avoid frequent changes as it can impact how your documentation is indexed by search engines.</p></div></div><p class="slate-p " ></p><h3 class="slate-h3 " ><strong class="slate-bold">
How do I restore my last published project?</strong></h3><p class="slate-p " >Here&apos;s how to achieve this:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Access Project History: Locate the top-right menu within the Theneo editor. </div></li><li class="slate-li " ><div style="position:relative">Select Desired Version:  Click on the &quot;History&quot; option within the menu. This will display a list of previous versions associated with your project.</div></li><li class="slate-li " ><div style="position:relative">Identify and Restore:  Find the version corresponding to your last published project. This can be identified by a timestamp. Once you&apos;ve located it, click to restore.</div></li></ul><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><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 " >Following these steps will replace your current project version with the last published version.</p></div></div><h3 class="slate-h3 " ><strong class="slate-bold">How to download published document?
</strong></h3><p class="slate-p slate-indent-0" style="0px">Downloading published document is currently available in our growth package, please contact our customer support directly at hello@theneo.io for an access.</p><p class="slate-p " ></p>

To delete a parameter, follow these steps:

To permanently remove your account and all associated data, please contact our support team directly at hello@theneo.io. A support representative will guide you through the secure account deletion process.

You can create a workspace in Theneo using one of the following methods:

If the corporate workspace toggle is enabled during sign-up, you can:

If the corporate workspace toggle is disabled during sign-up, you will automatically be added to your personal workspace upon account creation.

If you already have an account with a personal workspace, you can convert it to a corporate workspace:


How can I link sections within my Theneo documentation?

Switch to the editor view within your Theneo project.

By following these steps, you've successfully established a hyperlink within your Theneo documentation, allowing readers to navigate seamlessly between different sections.


Can I update the auto-generated URL slug?


How do I restore my last published project?

Downloading published document is currently available in our growth package, please contact our customer support directly at hello@theneo.io for an access.