Theneo

Theneo Quickstart Guide

API Reference

API Import & Specs

API Testing

API Changelog

API Versioning

API Schema Editor

Editor

Web Editor Widgets

Preview Changes

Automation & Dev Tools

Github Actions

Bitbucket

Visual Studio Code Extension

Theneo CLI

Theneo SDK

Atlassian Compass

AI Co-pilot & Chat

AI co-pilot

AI chat / chatGPT

Theneo Documentation

Published View

Branding & Styling

Customizing project look

Custom domain

Developer portal styling

Custom analytics

Developer Portal

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's how you can quickly set up your project in Theneo</p><p class="slate-p " ></p><div style="text-align:center"><a href="https://theneo-prod-public.s3.us-east-1.amazonaws.com/9e442a2e-a6f2-47ec-8aca-6cdea5ff6827.png" target="_blank" rel="noreferrer"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/9e442a2e-a6f2-47ec-8aca-6cdea5ff6827.png" style="width:824px;
	  height:490px;
	  aspect-ratio:824 / 490" /></a></div><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" 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 " >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/new-guide/product-and-user-guides-docs" target="_self">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're on your way. For detailed instructions on workspaces, check out our guides</p><h3 class="slate-h3 " >
1. 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'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'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%;" 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 " >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><h3 class="slate-h3 " >
2. Selecting Your AI Co-pilot</h3><p class="slate-p " >Once your API specification is uploaded, you can harness the power of Theneo's AI Co-pilot to enrich your content. Decide whether you want the AI to fully generate the content, enhance what you've already created, or if you prefer to proceed without AI assistance. If you're looking to streamline the setup, simply click on "Quick Start" to bypass the customization and move directly to publishing.</p><p class="slate-p " ></p><div style="text-align:center"><a href="https://theneo-prod-public.s3.us-east-1.amazonaws.com/88b6be9d-6320-4270-a4b6-675e6aa1e8f5.png" target="_blank" rel="noreferrer"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/88b6be9d-6320-4270-a4b6-675e6aa1e8f5.png" style="width:768px;
	  height:290px;
	  aspect-ratio:768 / 290" /></a></div><h3 class="slate-h3 " >

3. 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'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%;" 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 " >You can change project level permission and even set up advanced access management later in the project settings.</p></div></div><h3 class="slate-h3 " >4. Publish </h3><p class="slate-p slate-indent-0" style="0px">
Utilize Theneo'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


<strong class="slate-bold">Optional steps: </strong></p><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><p class="slate-p " ></p><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

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're equipped with Swagger, OpenAPI, GraphQL, or another format, the upload process is designed to be straightforward and efficient.

In case you don'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.

Once your API specification is uploaded, you can harness the power of Theneo's AI Co-pilot to enrich your content. Decide whether you want the AI to fully generate the content, enhance what you've already created, or if you prefer to proceed without AI assistance. If you're looking to streamline the setup, simply click on "Quick Start" to bypass the customization and move directly to publishing.



3. Setting Permissions and Fine-Tuning Your Project

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're ready, seamlessly inviting others to contribute. Manage these settings at any time to fit your project’s development lifecycle.


Utilize Theneo'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 class="slate-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:</p><h3 class="slate-h3 " ><strong class="slate-bold">API Formats Supported:</strong></h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">REST</div></li><li class="slate-li " ><div style="position:relative">SOAP</div></li><li class="slate-li " ><div style="position:relative">GraphQL</div></li><li class="slate-li " ><div style="position:relative">Async APIs</div></li></ul><h3 class="slate-h3 " >
Collection Types Supported:</h3><p class="slate-p " ><strong class="slate-bold">For REST APIs:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">OpenAPI 3.0</div></li><li class="slate-li " ><div style="position:relative">OpenAPI 3.1</div></li><li class="slate-li " ><div style="position:relative">Swagger 2</div></li><li class="slate-li " ><div style="position:relative">Postman Collections</div></li><li class="slate-li " ><div style="position:relative">Insomnia Collections
</div></li></ul><p class="slate-p " ><strong class="slate-bold">For SOAP APIs:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">HAR</div></li><li class="slate-li " ><div style="position:relative">WSDL
</div></li></ul><p class="slate-p " ><strong class="slate-bold">For GraphQL:</strong>
Standard GraphQL Specifications</p><p class="slate-p " >
In the following sections, we'll delve into each of these formats and collections, providing detailed insights and instructions.</p><p class="slate-p " ></p><p class="slate-p " ></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 class="slate-p " >REST (Representational State Transfer) APIs are widely used due to their simplicity and statelessness. Theneo supports REST APIs through various collection formats, ensuring compatibility and ease of integration.</p><h3 class="slate-h3 " >Supported Collections for REST APIs</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">OpenAPI 3.0 and 3.1:</strong></span> These specifications enable the definition of a REST API, including endpoints, methods, responses, and more, providing a comprehensive and standardized approach to RESTful services. <strong class="slate-bold">⬇️ </strong><a href="https://theneo-prod-public.s3.amazonaws.com/theneo/example-api-specs/openapi3.yaml" target="_self"><strong class="slate-bold">Download a sample file </strong></a></div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Swagger 2:</strong></span> A predecessor to OpenAPI, Swagger 2 allows for detailed API definitions and includes tools for auto-generating documentation, client SDKs, and more. <strong class="slate-bold">💾 </strong><a href="https://theneo-prod-public.s3.amazonaws.com/theneo/example-api-specs/swagger2.yaml" target="_self"><strong class="slate-bold">Download a sample file </strong></a> </div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Postman Collections:</strong></span> Widely used for API testing, Postman collections allow you to define requests, tests, and scripts for API endpoints.<strong class="slate-bold">⬇️ </strong><a href="https://theneo-prod-public.s3.amazonaws.com/theneo/example-api-specs/postman_collection.json" target="_self"><strong class="slate-bold">Download a sample file </strong></a></div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Insomnia Collections:</strong></span> Similar to Postman, Insomnia offers a platform for API design and testing, with an emphasis on simplicity and a clean interface. <strong class="slate-bold">⬇️ Download a sample file </strong></div></li></ul><p class="slate-p " ></p><p class="slate-p " >On the right side, you can see what an example REST API looks like. and below you should see how we automatically render the request and response descriptions. While these are automatically rendered you can also turn them off → see article </p><p class="slate-p " ></p><div style="width:60%;
	min-width:60%;" 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 " >Below and right API request examples and responses are all fake, just for demo purposes </p></div></div><p class="slate-p " ></p>

REST (Representational State Transfer) APIs are widely used due to their simplicity and statelessness. Theneo supports REST APIs through various collection formats, ensuring compatibility and ease of integration.

On the right side, you can see what an example REST API looks like. and below you should see how we automatically render the request and response descriptions. While these are automatically rendered you can also turn them off → see article 

REST API

The title of this week's epic saga. Make it sound like it's the next blockbuster movie or a top-selling fantasy novel

adventureTitle

Which chapter are we in our annual adventure? Week 1 is just 'Once Upon a Time,' but by Week 52, you're at 'Happily Ever After

weekNumber

theneoHighlights

teamHeroes

What grand discovery or idea did the team unearth this week? 'Ancient Algorithm of Awesome' or 'Cache of Cutting-Edge Concepts'?

treasureUnearthed

True or false: Did the team face any metaphorical dragons this week? Budget cuts, server outages, or coffee shortages?

dragonEncountered

When does the next adventure begin? Date of the upcoming sprint, meeting, or milestone

nextEpicChapterDate

Rate the team's spirit on a scale of 1 (a lone goblin) to 5 (a triumphant army of code warriors)

teamMorale

Authorization

Confirm the success of the request with a concise message.

statusCode

statusMessage

Provides a brief overview of the week's adventure, including:

summary

errorDetail

<p class="slate-p " >SOAP (Simple Object Access Protocol) APIs are a protocol standard for web services that enable the exchange of structured information. Theneo supports SOAP APIs through a variety of collection formats, which ensures comprehensive interoperability and integration capabilities.</p><h3 class="slate-h3 " >Supported Collections for SOAP APIs</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">HAR (HTTP Archive format):</strong></span> This file format records the web requests and responses that your SOAP API makes. It's incredibly useful for reproducing and debugging issues.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">⬇️ </strong><a href="https://app.theneo.io/theneo/quickstar" target="_self"><strong class="slate-bold">Download a sample file </strong></a></div></li></ul></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">WSDL (Web Services Description Language):</strong></span> WSDL is an XML-based protocol for information exchange in decentralized and distributed environments. Theneo fully supports WSDL for defining network services as sets of endpoints operating on messages.</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">⬇️ </strong><a href="https://app.theneo.io/theneo/quickstar" target="_self"><strong class="slate-bold">Download a sample file </strong></a></div></li></ul></li></ul><p class="slate-p " >On the right side, you can see an example SOAP request and the corresponding WSDL file structure. Below you can see how we automatically render the SOAP envelope and its headers, including the action and body content. You can also toggle to view the raw XML.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

SOAP (Simple Object Access Protocol) APIs are a protocol standard for web services that enable the exchange of structured information. Theneo supports SOAP APIs through a variety of collection formats, which ensures comprehensive interoperability and integration capabilities.

On the right side, you can see an example SOAP request and the corresponding WSDL file structure. Below you can see how we automatically render the SOAP envelope and its headers, including the action and body content. You can also toggle to view the raw XML.

SOAP API

Envelope

<p class="slate-p slate-indent-0" style="0px">GraphQL is a powerful data query and manipulation language for APIs, and a runtime for fulfilling queries with existing data. Theneo's GraphQL API support allows clients to request exactly what they need and nothing more, making it easier to evolve APIs over time.</p><p class="slate-p slate-indent-0" style="0px">Simply import a .graphql spec and let Theneo parse the entire doc. </p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">⬇️ </strong><a href="https://theneo-prod-public.s3.amazonaws.com/theneo/example-api-specs/countries.graphql" target="_self"><strong class="slate-bold">Download a sample file </strong></a></div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Sample GraphQL doc </strong></div></li></ul><h3 class="slate-h3 " >How we parse and output the GraphQL spec </h3><p class="slate-p " >Theneo's GraphQL API support provides a structured way to define and interact with your data. The schema you see is automatically parsed by Theneo to facilitate clear and efficient data retrieval and manipulation. Here's an in-depth look at the key components of a GraphQL schema and their importance:</p><h2 class="slate-h2 " >Query</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Definition:</strong></span> A Query is a read-only fetch operation to request data from your GraphQL server. It's akin to performing a <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">GET</strong></code></span> request in a REST API.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Theneo's Parsing:</strong></span> Theneo interprets the <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">Query</strong></code></span> type definitions to allow clients to make requests for specific data. The <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">weeklyAdventure</strong></code></span> query is automatically grouped under the <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">Query</strong></code></span> category in the API reference documentation, showcasing its available parameters and return type.</div></li></ul><h2 class="slate-h2 " >Mutation</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Definition:</strong></span> Mutations are how you create, update, or delete data. This is similar to <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">POST</strong></code></span>, <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">PUT</strong></code></span>, <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">PATCH</strong></code></span>, or <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">DELETE</strong></code></span> in REST.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Theneo's Parsing:</strong></span> Although not explicitly shown in the provided schema, any defined mutations would be parsed and displayed under this section, detailing how clients can modify data.</div></li></ul><h2 class="slate-h2 " >Subscription</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Definition:</strong></span> Subscriptions maintain a steady connection to the server, allowing clients to receive real-time updates.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Theneo's Parsing:</strong></span> Theneo would parse and categorize any subscriptions in the schema, explaining how clients can establish a persistent connection to listen for specific events.</div></li></ul><h2 class="slate-h2 " >Objects</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Definition:</strong></span> GraphQL objects represent a list of named fields, each of which can return a specific type. They can be thought of as the building blocks of your GraphQL API.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Theneo's Parsing:</strong></span> The schema's objects like <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">WeeklyAdventure</strong></code></span>, <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">TheneoHighlights</strong></code></span>, and <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">HeroHighlight</strong></code></span> are parsed and displayed with their fields and respective types, indicating the shape of the data that clients can expect to receive.</div></li></ul><h2 class="slate-h2 " >Scalars</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Definition:</strong></span> Scalars are primitive data types (e.g., <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">Int</strong></code></span>, <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">Float</strong></code></span>, <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">String</strong></code></span>, <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">Boolean</strong></code></span>) that resolve to a single scalar object, and they are the leaves of the query.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Theneo's Parsing:</strong></span> Theneo highlights these fundamental types in the schema, showcasing where they are used within object fields to define the type of data they represent.</div></li></ul><h2 class="slate-h2 " >Directives</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Definition:</strong></span> Directives provide a way to dynamically alter the execution of a query or mutation.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Theneo's Parsing:</strong></span> If any directives are used in the schema, Theneo would explain their use cases, such as conditionally including or skipping fields.</div></li></ul><h2 class="slate-h2 " >Enums</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Definition:</strong></span> Enums are a special kind of scalar that is restricted to a particular set of allowed values. They validate that any arguments of that type are one of the allowed values.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Theneo's Parsing:</strong></span> The <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">Mood</strong></code></span> enum in the schema is parsed and documented, indicating the fixed set of options that can be used for fields of this type.</div></li></ul><h2 class="slate-h2 " >Unions</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Definition:</strong></span> Unions are similar to interfaces but they can't specify any common fields between the types.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Theneo's Parsing:</strong></span> If there were unions in the schema, Theneo would parse these and illustrate how they can be used to return an object that could be one of several types.</div></li></ul><p class="slate-p " >The Theneo GraphQL schema parsing feature automatically structures and documents these elements for developers to easily understand and interact with the API. Each component plays a crucial role in defining the capabilities and constraints of the API, ensuring a robust and flexible interface for interacting with data.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

GraphQL is a powerful data query and manipulation language for APIs, and a runtime for fulfilling queries with existing data. Theneo's GraphQL API support allows clients to request exactly what they need and nothing more, making it easier to evolve APIs over time.

Simply import a .graphql spec and let Theneo parse the entire doc. 

How we parse and output the GraphQL spec 

Theneo's GraphQL API support provides a structured way to define and interact with your data. The schema you see is automatically parsed by Theneo to facilitate clear and efficient data retrieval and manipulation. Here's an in-depth look at the key components of a GraphQL schema and their importance:

The Theneo GraphQL schema parsing feature automatically structures and documents these elements for developers to easily understand and interact with the API. Each component plays a crucial role in defining the capabilities and constraints of the API, ensuring a robust and flexible interface for interacting with data.

GraphQL

weeklyAdventure

<p class="slate-p " >Theneo offers seamless integration with Postman, making it possible to import your Postman collections into Theneo for enhanced API documentation. Below is a straightforward guide to establishing this integration.</p><div style="text-align:center"><iframe
                        title="embed"
                        frameBorder="0"
                        allowFullScreen=""
                        src="https://www.youtube.com/embed/LkSer8YhGDQ"
                        id="LkSer8YhGDQ"
                        provider="youtube"
                        class="slate-MediaEmbedElement-iframe"
                        width="41.243654822335024%"
                    ></iframe></div><p class="slate-p " ></p><h2 class="slate-h2 " >Connecting Postman with Theneo</h2><p class="slate-p " >You can integrate your Postman collections with Theneo during two key phases:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">When creating a new project</div></li><li class="slate-li " ><div style="position:relative">When editing an existing project</div></li></ul><h3 class="slate-h3 " >A) Creating a New Project with Postman Integration</h3><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Start a New Project:</strong></span></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Navigate to the Theneo dashboard and click on <span style="color:var(--tw-prose-bold)"><strong class="slate-bold">"Create Project."</strong></span></div></li></ul></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Connect to Postman:</strong></span></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Select <span style="color:var(--tw-prose-bold)"><strong class="slate-bold">"Connect to Postman"</strong></span> from the project setup options.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Provide Your Postman API Key:</strong></span></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Enter your Postman API key in the designated field.</div></li></ul></li></ol><h4 class="slate-h4 " >Generating a Postman API Key:</h4><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Log into your Postman account.</div></li><li class="slate-li " ><div style="position:relative">Go to <span style="color:var(--tw-prose-bold)"><strong class="slate-bold">"Profile"</strong></span> > <span style="color:var(--tw-prose-bold)"><strong class="slate-bold">"Settings."</strong></span></div></li><li class="slate-li " ><div style="position:relative">Access the <span style="color:var(--tw-prose-bold)"><strong class="slate-bold">"API Keys"</strong></span> section.</div></li><li class="slate-li " ><div style="position:relative">Click on <span style="color:var(--tw-prose-bold)"><strong class="slate-bold">"Generate API Key,"</strong></span> name it, and hit generate.</div></li><li class="slate-li " ><div style="position:relative">Copy the newly created API key.</div></li></ul><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Import Collections:</strong></span></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Once the API key is validated, your Postman collections will be listed.</div></li><li class="slate-li " ><div style="position:relative">Select the collections you want to import or choose <span style="color:var(--tw-prose-bold)"><strong class="slate-bold">"Select All."</strong></span></div></li><li class="slate-li " ><div style="position:relative">Click on <span style="color:var(--tw-prose-bold)"><strong class="slate-bold">"Import."</strong></span></div></li></ul></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Create the Project:</strong></span></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">With collections imported, click <span style="color:var(--tw-prose-bold)"><strong class="slate-bold">"Create Project"</strong></span> to finalize.</div></li></ul></li></ol><h3 class="slate-h3 " >B) Adding Postman Collections to an Existing Project</h3><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Edit Your Project:</strong></span></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">From the Theneo dashboard, open your existing project and choose <span style="color:var(--tw-prose-bold)"><strong class="slate-bold">"Edit."</strong></span></div></li></ul></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Navigate to Endpoints:</strong></span></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">In the project editor, go to the <span style="color:var(--tw-prose-bold)"><strong class="slate-bold">"Endpoints"</strong></span> section where your current API endpoints are listed.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Initiate Import:</strong></span></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Click on the <span style="color:var(--tw-prose-bold)"><strong class="slate-bold">import icon</strong></span> and select <span style="color:var(--tw-prose-bold)"><strong class="slate-bold">"Connect to Postman."</strong></span></div></li></ul></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Enter Postman API Key:</strong></span></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Provide your Postman API key when prompted.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Import Collections:</strong></span></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">After authentication, your Postman collections will be displayed.</div></li><li class="slate-li " ><div style="position:relative">Select the desired collections or <span style="color:var(--tw-prose-bold)"><strong class="slate-bold">"Select All,"</strong></span> then click <span style="color:var(--tw-prose-bold)"><strong class="slate-bold">"Import."</strong></span></div></li></ul></li></ol><p class="slate-p " >By following these steps, your Postman collections will be integrated into Theneo, streamlining your API documentation workflow.</p><p class="slate-p " ></p>

Theneo offers seamless integration with Postman, making it possible to import your Postman collections into Theneo for enhanced API documentation. Below is a straightforward guide to establishing this integration.

You can integrate your Postman collections with Theneo during two key phases:

A) Creating a New Project with Postman Integration

B) Adding Postman Collections to an Existing Project

By following these steps, your Postman collections will be integrated into Theneo, streamlining your API documentation workflow.

Postman Collection

<p class="slate-p " >The Custom SDK Import feature in Theneo allows users to integrate their own SDKs for use within the platform. This feature currently supports OpenAPI specifications. By adding the <span style="color:var(--tw-prose-code)"><code class="slate-code"><strong class="slate-bold">x-theneo-endpoint-metadata</strong></code></span> property to your OpenAPI spec, Theneo will be able to import and utilize your custom SDK in the platform's interface.</p><h3 class="slate-h3 " >Steps for Importing Custom SDK</h3><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Prepare Your OpenAPI Specification:</strong></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Ensure your OpenAPI spec is up to date and reflects the endpoints you wish to use with the Theneo platform.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Add Custom SDK Metadata:</strong></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Within your OpenAPI spec, add the<code class="slate-code"> x-theneo-endpoint-metadata </code>field to the endpoints where you want to use your custom SDK.</div></li><li class="slate-li " ><div style="position:relative">Include code examples for supported languages under the examples </div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Example of Custom SDK Metadata: or check out this ful</strong><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">l </strong></span><a href="https://theneo-prod-public.s3.amazonaws.com/theneo/example-api-specs/pet-store-openapi-v3.json" target="_self"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">sample spec</strong></span></a></div></li></ol><div class="code-block-wrapper" style="width:60%"><div class="code-block-header">YAML</div><pre class="slate-CodeBlockElement slate-code_block"><code class="language-yaml keep-markup drop-tokens"><div class="slate-code_line">"x-theneo-endpoint-metadata": {</div><div class="slate-code_line">          "examples": [</div><div class="slate-code_line">            {</div><div class="slate-code_line">              "title": "Create a Pet",</div><div class="slate-code_line">              "request": {</div><div class="slate-code_line">                "python": "from swagger_petstore_sdk import PetstoreClient\n\n# Python\nclient = PetstoreClient()\nnew_pet = {'name': 'NewPet', 'tag': 'Tag123'}\nresponse = client.create_pet(new_pet)\nprint(response.status_code)",</div><div class="slate-code_line">                "javascript": "import { PetstoreClient } from 'swagger-petstore-sdk';\n\n// JavaScript\nconst client = new PetstoreClient();\nconst newPet = { name: 'NewPet', tag: 'Tag123' };\nconst response = await client.createPet(newPet);\nconsole.log(response.status)"</div><div class="slate-code_line">              }</div><div class="slate-code_line">            }</div><div class="slate-code_line">          ]</div><div class="slate-code_line">        } </div></code></pre></div><p class="slate-p " ></p><p class="slate-p " ><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Import the OpenAPI Spec to Theneo:</strong></span></p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">After updating your OpenAPI spec, import it into Theneo.</div></li><li class="slate-li " ><div style="position:relative">Theneo will read the <code class="slate-code">x-theneo-endpoint-metadata</code> and populate the SDK selection dropdown with your custom SDK options.</div></li></ol><h4 class="slate-h4 " >Supported Languages</h4><p class="slate-p " >Currently, Theneo supports importing SDK examples written in the following languages:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">curl</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">python</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">javascript</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">go</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">java</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">csharp</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">php</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">ruby</code></div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">graphql</code></div></li></ul><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Upcoming Language Support</strong></p><p class="slate-p slate-indent-0" style="0px">Theneo plans to expand support to additional languages in the future. Keep an eye on the platform updates for when these become available.</p><h3 class="slate-h3 " >Technical Requirements and Limitations</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">OpenAPI Specification: Your API must have an OpenAPI specification to use this feature.</div></li><li class="slate-li " ><div style="position:relative">Endpoint Metadata: The <code class="slate-code">x-theneo-endpoint-metadata </code>field is necessary for Theneo to recognize and import the SDK properly.</div></li><li class="slate-li " ><div style="position:relative">Editor Limitation: Currently, modifications to the x-theneo-endpoint-metadata for the purpose of custom SDK integration cannot be made directly within the Theneo editor. These changes must be made to the OpenAPI spec file before importing it into Theneo.</div></li></ul><p class="slate-p slate-indent-0" style="0px">By adhering to these guidelines, you can effectively document and import your custom SDKs into Theneo, providing a seamless experience for users to interact with your API through the platform.
</p><p class="slate-p " ></p>

The Custom SDK Import feature in Theneo allows users to integrate their own SDKs for use within the platform. This feature currently supports OpenAPI specifications. By adding the 

 property to your OpenAPI spec, Theneo will be able to import and utilize your custom SDK in the platform's interface.

Currently, Theneo supports importing SDK examples written in the following languages:

Theneo plans to expand support to additional languages in the future. Keep an eye on the platform updates for when these become available.

By adhering to these guidelines, you can effectively document and import your custom SDKs into Theneo, providing a seamless experience for users to interact with your API through the platform.


Importing custom SDK

<p class="slate-p " >Theneo allows you to import additional configuration options directly from your OpenAPI specification using the x-theneo-metadata attribute. This custom extension provides more flexibility, allowing you to define a complex structure and additional settings for how your API documentation is organized and displayed, offering much more configuration than what’s possible with a traditional OpenAPI spec.</p><p class="slate-p " ><strong class="slate-bold">What does x-theneo-metadata do?</strong></p><p class="slate-p " >The <code class="slate-code">x-theneo-metadata</code> attribute gives you the ability to add sections, sub-sections, and other properties that control how your API documentation is structured. This lets you create a more detailed and customized hierarchy, offering more complex configuration options beyond the standard OpenAPI capabilities.</p><p class="slate-p slate-indent-0" style="0px">Key Features of x-theneo-metadata:</p><p class="slate-p " >	•	<code class="slate-code"><strong class="slate-bold">menu</strong></code>: This array lets you organize your documentation into sections, which can include:</p><p class="slate-p " >	•	<code class="slate-code"><strong class="slate-bold">name</strong></code>: The title of the section that will appear in the menu.</p><p class="slate-p " >	•	<code class="slate-code"><strong class="slate-bold">description</strong></code>: A brief explanation of the section’s content.</p><p class="slate-p " >	•	<code class="slate-code"><strong class="slate-bold">icon</strong></code>: (Optional) A visual icon that represents the section.</p><p class="slate-p " >	•	<code class="slate-code"><strong class="slate-bold">openDefault</strong></code>: (Optional) Determines if the section should be expanded by default when the documentation is first loaded.</p><p class="slate-p " >	•	<code class="slate-code"><strong class="slate-bold">isHeader</strong></code>: (Optional) Specifies whether the section is just a header with no further details or endpoints under it.</p><p class="slate-p " >	•	<code class="slate-code"><strong class="slate-bold">isPrivate</strong></code>: (Optional) Allows you to mark sections as private, restricting them to specific users.</p><p class="slate-p " >	•	<code class="slate-code"><strong class="slate-bold">viewers</strong></code>: (Optional) An array of email addresses for users who are permitted to view private sections.</p><p class="slate-p " >	•	<code class="slate-code"><strong class="slate-bold">operationId</strong></code>: (Optional) Links a section or sub-section to a specific API operation (endpoint) using the operationId from your OpenAPI spec.</p><p class="slate-p " >	•	<code class="slate-code"><strong class="slate-bold">subSections</strong></code>: Lets you create nested sections within a larger section, allowing for a more detailed breakdown.</p><p class="slate-p " ></p><p class="slate-p " >Example: </p><div class="code-block-wrapper" style="width:60%"><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">x-theneo-metadata:
menu:
- name: Pet endpoints
  description: "A section for managing pet-related API operations."
  icon: https://theneo-prod-public.s3.us-east-1.amazonaws.com/theneo/make/api-explorer.png
  subSections:
    - name: List Pets
      operationId: listPets
    - name: Get Pet information using ID
      operationId: showPetById
  subSections:
    - name: Add new pet
    operationId: createPets
- name: Header Section
  openDefault: true
  isHeader: true
  subSections:
    - name: Private Section
    isPrivate: true
    viewers:
      - test@theneo.io
    description: "Details that only certain users can see."</div></code></pre></div><p class="slate-p " ><strong class="slate-bold">Why is this useful for you?</strong></p><p class="slate-p " >By using x-theneo-metadata in your OpenAPI spec, you can define a much more complex and customizable structure for your API documentation. It allows you to create detailed sections, control visibility, and link directly to specific API operations. This flexibility goes beyond what a traditional OpenAPI spec can offer, giving you more control over how your API documentation is organized and presented.</p><p class="slate-p " ></p>

Theneo allows you to import additional configuration options directly from your OpenAPI specification using the x-theneo-metadata attribute. This custom extension provides more flexibility, allowing you to define a complex structure and additional settings for how your API documentation is organized and displayed, offering much more configuration than what’s possible with a traditional OpenAPI spec.

 attribute gives you the ability to add sections, sub-sections, and other properties that control how your API documentation is structured. This lets you create a more detailed and customized hierarchy, offering more complex configuration options beyond the standard OpenAPI capabilities.

: This array lets you organize your documentation into sections, which can include:

: The title of the section that will appear in the menu.

: A brief explanation of the section’s content.

: (Optional) A visual icon that represents the section.

: (Optional) Determines if the section should be expanded by default when the documentation is first loaded.

: (Optional) Specifies whether the section is just a header with no further details or endpoints under it.

: (Optional) Allows you to mark sections as private, restricting them to specific users.

: (Optional) An array of email addresses for users who are permitted to view private sections.

: (Optional) Links a section or sub-section to a specific API operation (endpoint) using the operationId from your OpenAPI spec.

: Lets you create nested sections within a larger section, allowing for a more detailed breakdown.

By using x-theneo-metadata in your OpenAPI spec, you can define a much more complex and customizable structure for your API documentation. It allows you to create detailed sections, control visibility, and link directly to specific API operations. This flexibility goes beyond what a traditional OpenAPI spec can offer, giving you more control over how your API documentation is organized and presented.

Theneo custom metadata

<p class="slate-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 style="text-align:center"><a href="https://theneo-prod-public.s3.us-east-1.amazonaws.com/images-1705100031015.png" target="_blank" rel="noreferrer"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/images-1705100031015.png" style="width:auto;height:100%" /></a></div><h3 class="slate-h3 " >Key Features of API Explorer</h3><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Real-Time Testing</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">Try in API Explorer Button</strong></span>: Every API request in our documentation includes a “Try in API Explorer” button, allowing instant, live interaction with your APIs.</div></li></ul><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Environment Selection</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">Sandbox and Production Toggle</strong></span>: Test your APIs in a safe sandbox environment or in a live production setting with a simple switch.</div></li></ul><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">User-Friendly Interface</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">Form and Code View</strong></span>: Choose your comfort zone—use the Form View for a guided input experience or the Code View to enter your custom code snippets.</div></li></ul><p class="slate-p " ></p><div style="text-align:center"><a href="https://theneo-prod-public.s3.us-east-1.amazonaws.com/images-1705100084676.png" target="_blank" rel="noreferrer"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/images-1705100084676.png" style="width:auto;height:100%" /></a></div><p class="slate-p slate-indent-0" style="0px">Seamless Navigation</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Effortless Section Switching</strong></span>: Navigate between different API sections directly in the Explorer without needing to refer back to the documentation.</div></li></ul><p class="slate-p slate-indent-0" style="0px">Informative Fields</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Field Descriptions</strong></span>: Understand each parameter with clear descriptions and details provided within the Explorer.</div></li></ul><p class="slate-p " ></p><div style="text-align:center"><a href="https://theneo-prod-public.s3.us-east-1.amazonaws.com/images-1705100146397.png" target="_blank" rel="noreferrer"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/images-1705100146397.png" style="width:auto;height:100%" /></a></div><h3 class="slate-h3 " >
Advantages of Using API Explorer</h3><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">No Setup Required</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">Automatic Synchronization</strong></span>: Changes made in the editor or updates from your API spec are automatically reflected in the API Explorer, eliminating the need for manual setup.</div></li></ul><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Accessible to All User Levels</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">Designed for Everyone</strong></span>: The API Explorer is crafted to be accessible to users of all skill levels, breaking down barriers to API testing.</div></li></ul><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Enhanced Learning and Debugging</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">Interactive Learning</strong></span>: By experimenting with live API calls, users can learn more effectively and pinpoint issues on the fly.</div></li></ul><p class="slate-p " >
</p><p class="slate-p " ></p><p class="slate-p " ></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 class="slate-p slate-indent-0" style="0px">Pre-Request Scripts allow you to execute code before each HTTP request, making them ideal for tasks such as authentication, request headers manipulation, and setting up a consistent environment before fetching data from an external API. By incorporating pre-request scripts, you can streamline your request handling process and ensure consistent behavior across various endpoints.</p><div style="text-align:center"><a href="https://theneo-prod-public.s3.us-east-1.amazonaws.com/a4595456-0cc0-47a6-abd6-72b47c305d31.png" target="_blank" rel="noreferrer"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/a4595456-0cc0-47a6-abd6-72b47c305d31.png" style="width:764px;
	  height:800px;
	  aspect-ratio:764 / 800" /></a></div><h2 class="slate-h2 " >Key Actions in Pre-Request Scripts</h2><h4 class="slate-h4 " >1. Reading Environment Variables</h4><p class="slate-p " >You can access environment variables using the following syntax:</p><div class="code-block-wrapper" style="width:60%"><div class="code-block-header">JavaScript</div><pre class="slate-CodeBlockElement slate-code_block"><code class="language-javascript keep-markup drop-tokens"><div class="slate-code_line">const myVariable = theneo.variables["variable-name"]; </div></code></pre></div><h4 class="slate-h4 " >2. Reading Endpoints</h4><p class="slate-p " >To access endpoints, use:</p><div class="code-block-wrapper" style="width:60%"><div class="code-block-header">JavaScript</div><pre class="slate-CodeBlockElement slate-code_block"><code class="language-javascript keep-markup drop-tokens"><div class="slate-code_line">const myEndpoint = theneo.endpoints</div></code></pre></div><h4 class="slate-h4 " >3. Reading Parameters</h4><p class="slate-p " >To access parameters, use</p><div class="code-block-wrapper" style="width:60%"><div class="code-block-header">JavaScript</div><pre class="slate-CodeBlockElement slate-code_block"><code class="language-javascript keep-markup drop-tokens"><div class="slate-code_line">const myParameter = theneo.parameters</div></code></pre></div><h4 class="slate-h4 " >4. Reading Query Parameters</h4><p class="slate-p " >To access query parameters, use</p><div class="code-block-wrapper" style="width:60%"><div class="code-block-header">JavaScript</div><pre class="slate-CodeBlockElement slate-code_block"><code class="language-javascript keep-markup drop-tokens"><div class="slate-code_line">const myQueryParameter = theneo.queryParameters</div></code></pre></div><h4 class="slate-h4 " >5. Reading Header Variables</h4><p class="slate-p " >To access header variables, use:</p><div class="code-block-wrapper" style="width:60%"><div class="code-block-header">JavaScript</div><pre class="slate-CodeBlockElement slate-code_block"><code class="language-javascript keep-markup drop-tokens"><div class="slate-code_line">const myHeader = theneo.headers["header-name"];</div></code></pre></div><h4 class="slate-h4 " >6. Setting Header Values</h4><p class="slate-p " >You can set header values with:</p><div class="code-block-wrapper" style="width:60%"><div class="code-block-header">JavaScript</div><pre class="slate-CodeBlockElement slate-code_block"><code class="language-javascript keep-markup drop-tokens"><div class="slate-code_line">theneo.headers["header-name"] = "header value";</div></code></pre></div><h4 class="slate-h4 " >7. Reading Request Body</h4><p class="slate-p " >Access the request body in JSON format with:</p><div class="code-block-wrapper" style="width:60%"><div class="code-block-header">JavaScript</div><pre class="slate-CodeBlockElement slate-code_block"><code class="language-javascript keep-markup drop-tokens"><div class="slate-code_line">const requestBody = theneo.requestBody.json;</div></code></pre></div><h4 class="slate-h4 " >8. Sending Requests within Pre-Request Scripts</h4><p class="slate-p " >You can send requests to other endpoints using the fetch API.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h3 class="slate-h3 " >Example: Setting an Authorization Header</h3><p class="slate-p " >Here’s a quick example of a pre-request script that sets an Authorization header:</p><div class="code-block-wrapper" style="width:60%"><div class="code-block-header">JavaScript</div><pre class="slate-CodeBlockElement slate-code_block"><code class="language-javascript keep-markup drop-tokens"><div class="slate-code_line">const token = theneo.variables["authToken"];
theneo.headers["Authorization"] = Bearer ${token};</div></code></pre></div><h3 class="slate-h3 " >Example Script</h3><p class="slate-p " >Here’s a full example of a complete Pre-Request Script:</p><div class="code-block-wrapper" style="width:60%"><div class="code-block-header">JavaScript</div><pre class="slate-CodeBlockElement slate-code_block"><code class="language-javascript keep-markup drop-tokens"><div class="slate-code_line">const apiKey = theneo.variables["apiKey"];</div><div class="slate-code_line">const apiSecret = theneo.variables["apiSecretKey"];</div><div class="slate-code_line">const timestamp = new Date().getTime();</div><div class="slate-code_line">console.log("API Key:", apiKey);</div><div class="slate-code_line">console.log("API Secret:", apiSecret);</div><div class="slate-code_line">console.log("Timestamp:", timestamp);</div><div class="slate-code_line">const requestData = JSON.stringify(theneo.requestBody.json, null, 0);</div><div class="slate-code_line">console.log("Request Data:", requestData);</div><div class="slate-code_line">const rawSignature = `${apiKey}:${timestamp}:${requestData}`;</div><div class="slate-code_line">console.log("Raw Signature:", rawSignature);</div><div class="slate-code_line">function generateHMAC(rawSignature, secret) {</div><div class="slate-code_line">    console.log("Generating HMAC with Raw Signature:", rawSignature, "and Secret:", secret);</div><div class="slate-code_line">    const signature = CryptoJS.HmacSHA256(rawSignature, secret);</div><div class="slate-code_line">    const hexSignature = CryptoJS.enc.Hex.stringify(signature);</div><div class="slate-code_line">    console.log("Computed Signature:", hexSignature);</div><div class="slate-code_line">    return hexSignature;</div><div class="slate-code_line">}</div><div class="slate-code_line">const signature = generateHMAC(rawSignature, apiSecret);</div><div class="slate-code_line">theneo.headers = {</div><div class="slate-code_line">    "API-Key": apiKey,</div><div class="slate-code_line">    "Timestamp": timestamp.toString(),</div><div class="slate-code_line">    "Signature": signature,</div><div class="slate-code_line">    "Content-Type": "application/json",</div><div class="slate-code_line">    "Accept": "*/*"</div><div class="slate-code_line">};</div><div class="slate-code_line">console.log("Headers set for request:", theneo.headers);</div></code></pre></div><p class="slate-p " ></p><div style="width:60%;
	min-width:60%;" data-type=warning ><div ><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 " > Currently, async operations are limited.</p></div></div><h3 class="slate-h3 " >Available Libraries</h3><div style="width:60%;
	min-width:60%;" 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 " >Currently, only the crypto library is available for use in your scripts. You can utilize any method provided by the crypto library.</p><p class="slate-p " >If you would like to use any additional library, please contact our support team at <a href="null" target="_blank">hello@theneo.io</a>.</p></div></div><h2 class="slate-h2 " >Running Your Script</h2><h3 class="slate-h3 " >1. Enabling Pre-Request Scripts</h3><p class="slate-p " >To enable pre-request scripts:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Navigate to your project settings.</div></li><li class="slate-li " ><div style="position:relative">Go to <strong class="slate-bold">Settings → Features → Pre-request script</strong>.</div></li></ul><h3 class="slate-h3 " >2. Running Your Script</h3><p class="slate-p " >After creating your script, you can run it using the API Explorer:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Press the <strong class="slate-bold">Run Request</strong> button.</div></li></ul><p class="slate-p " >The pre-request script will execute first, followed by your regular request.</p><h3 class="slate-h3 " >3. Verifying Your Script</h3><p class="slate-p " >Use the Network tab to check that the correct authorization values are sent during the request. This helps ensure that your pre-request script is functioning as expected.</p><h2 class="slate-h2 " >Quick Video Guide</h2><p class="slate-p " ></p><p class="slate-p " ></p><div style="text-align:center"><iframe
                        title="embed"
                        frameBorder="0"
                        allowFullScreen=""
                        src="https://player.vimeo.com/video/954154948"
                        id="954154948"
                        provider="vimeo"
                        class="slate-MediaEmbedElement-iframe"
                        width="55.203045685279186%"
                    ></iframe></div><h2 class="slate-h2 " >Reading External Query Parameters</h2><p class="slate-p " >To authenticate users in your API explorer by reading and using externally passed query parameters, such as <code class="slate-code">?my_token=<token></code>and utilizing them in the pre-request script context. </p><h4 class="slate-h4 " >Steps to Implement</h4><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Passing Query Parameters</strong></div></li></ol><p class="slate-p " >When redirecting users from your website to the API explorer, include the token as a query parameter in the URL. For example:</p><div class="code-block-wrapper" style="width:60%"><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><code class="language-plainText keep-markup drop-tokens"><div class="slate-code_line">https://api-explorer.yoursite.com?myToken=<token></div></code></pre></div><p class="slate-p slate-indent-0" style="0px">2.<strong class="slate-bold"> Using the Token in Pre-Request Script</strong></p><p class="slate-p slate-indent-0" style="0px">Modify the pre-request script to access the token from local storage and use it as needed.</p><div class="code-block-wrapper" style="width:60%"><div class="code-block-header">JavaScript</div><pre class="slate-CodeBlockElement slate-code_block"><code class="language-javascript keep-markup drop-tokens"><div class="slate-code_line">const userQueryParameters = theneo.userQueryParameters</div><div class="slate-code_line">console.log(theneo.userQueryParameters)</div></code></pre></div><p class="slate-p " ></p><p class="slate-p " ></p>

Pre-Request Scripts allow you to execute code before each HTTP request, making them ideal for tasks such as authentication, request headers manipulation, and setting up a consistent environment before fetching data from an external API. By incorporating pre-request scripts, you can streamline your request handling process and ensure consistent behavior across various endpoints.

You can access environment variables using the following syntax:

Access the request body in JSON format with:

8. Sending Requests within Pre-Request Scripts

You can send requests to other endpoints using the fetch API.

Here’s a quick example of a pre-request script that sets an Authorization header:

Here’s a full example of a complete Pre-Request Script:

After creating your script, you can run it using the API Explorer:

The pre-request script will execute first, followed by your regular request.

Use the Network tab to check that the correct authorization values are sent during the request. This helps ensure that your pre-request script is functioning as expected.

To authenticate users in your API explorer by reading and using externally passed query parameters, such as 

and utilizing them in the pre-request script context. 

When redirecting users from your website to the API explorer, include the token as a query parameter in the URL. For example:

Modify the pre-request script to access the token from local storage and use it as needed.

Pre-Request Script

<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"><a href="https://theneo-prod-public.s3.us-east-1.amazonaws.com/8a7be86e-d55b-4859-b60f-b6292c22e06b.png" target="_blank" rel="noreferrer"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/8a7be86e-d55b-4859-b60f-b6292c22e06b.png" style="width:839px;
	  height:460px;
	  aspect-ratio:839 / 460" /></a></div><h3 class="slate-h3 " >Automated Changelog Documentation</h3><p class="slate-p " >Whenever a new API spec is imported and the "Publish" 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 'Features' 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 'Public Changelog,' 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 class="slate-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 class="slate-p " >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.</p><p class="slate-p " ></p><div style="text-align:center"><a href="https://theneo-prod-public.s3.us-east-1.amazonaws.com/cfcdb64c-7c21-4008-8ed9-bd27c2e57def.png" target="_blank" rel="noreferrer"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/cfcdb64c-7c21-4008-8ed9-bd27c2e57def.png" style="width:878px;
	  height:485px;
	  aspect-ratio:878 / 485" /></a></div><p class="slate-p " ></p><h2 class="slate-h2 " >Key Features of API Versioning</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Multiple Versions</strong></span>: Create and manage multiple versions of your API, whether it’s incremental updates or major releases.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Status Labels</strong></span>: Assign statuses like active, beta, or deprecated to each version, along with any custom attributes you may need.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Project Configuration</strong></span>: Tailor each API version’s project settings, including access management, SEO settings, and analytics.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Version-Level Changelogs</strong></span>: Track changes within specific versions, enabling clear communication of updates from 1.1.2 to 1.1.3, etc.</div></li></ul><h2 class="slate-h2 " >How to Access API Versioning</h2><p class="slate-p " >As this is a beta feature, Theneo invites users to activate API versioning by reaching out to us:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Contact for Access</strong></span>: Send an email to <a href="null" target="_new">hello@theneo.io</a> expressing your interest in enabling API versioning for your account.</div></li></ul><h2 class="slate-h2 " >Utilizing the Versioning Feature</h2><p class="slate-p " >Once API versioning is enabled for your account, you can:</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Add New Versions</strong></span>: Easily add a new version through your project dashboard by importing a new API spec or using an existing one as a base.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Import Specs</strong></span>: Use the intuitive interface to upload file, link, import from Postman, or input raw text for your API specs.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Manage Versions</strong></span>: Navigate to the settings menu to manage features, access permissions, SEO optimization, and analytics for each API version.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Set Version Status</strong></span>: Define the lifecycle stage of each API version with appropriate status labels directly from the project versions screen.</div></li></ol><p class="slate-p " ></p><h3 class="slate-h3 " >Quick Video Guide</h3><div style="text-align:center"><iframe
                        title="embed"
                        frameBorder="0"
                        allowFullScreen=""
                        src="https://www.youtube.com/embed/uyBIR-g3o0g"
                        id="uyBIR-g3o0g"
                        provider="youtube"
                        class="slate-MediaEmbedElement-iframe"
                        width="52.53807106598985%"
                    ></iframe></div><p class="slate-p " ></p><h2 class="slate-h2 " >Contact Us</h2><p class="slate-p " >For more information on API versioning and to request access to this beta feature, please contact us at <a href="null" target="_new">hello@theneo.io</a>. We are committed to supporting you in leveraging this feature to its full potential, ensuring effective management of your API's lifecycle.</p><p class="slate-p " ></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 class="slate-p " >Theneo CLI now includes commands to facilitate robust version management for your projects. This guide provides detailed instructions on using the new project version commands and options.</p><p class="slate-p " >For detailed instructions on using the Theneo CLI tool, click <a href="https://app.theneo.io/theneo/quickstart/automation-and-dev-tools/theneo-cli" target="_self">here.</a></p><h3 class="slate-h3 " >Commands and Usage</h3><h4 class="slate-h4 " >Create a New Version</h4><p class="slate-p " >To create a new version of your project, use the <code class="slate-code">theneo version create</code> command. This command allows you to specify various options such as the version name, project slug, workspace slug, and the previous version to duplicate content from.</p><p class="slate-p " ><strong class="slate-bold">Command:</strong></p><div class="code-block-wrapper" style="width:60%"><div class="code-block-header">Bash</div><pre class="slate-CodeBlockElement slate-code_block"><code class="language-bash keep-markup drop-tokens"><div class="slate-code_line">theneo version create [options]</div></code></pre></div><p class="slate-p " ><strong class="slate-bold">Options:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">--name <name></code>: Specifies the name of the new version.</div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">--projectSlug <project-slug></code>: The project slug for which the version is being created.</div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">--workspace <workspace-slug></code>: The workspace slug where the project is located.</div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">--previousVersion <previous-version-slug></code>: The slug of the previous version to duplicate content from.</div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">--profile <string></code>: Use a specific profile from your config file.</div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">-h, --help</code>: Display help for the command.</div></li></ul><p class="slate-p " ></p><p class="slate-p " ><strong class="slate-bold">Example:</strong></p><div class="code-block-wrapper" style="width:60%"><div class="code-block-header">Bash</div><pre class="slate-CodeBlockElement slate-code_block"><code class="language-bash keep-markup drop-tokens"><div class="slate-code_line">theneo version create --name v2.0 --projectSlug my-project --workspace my-workspace --previousVersion v1.0</div></code></pre></div><h3 class="slate-h3 " >Project Version Commands</h3><p class="slate-p " >The <code class="slate-code">theneo version</code> command encompasses various actions related to project versions. These include listing, creating, and deleting project versions.</p><p class="slate-p " ><strong class="slate-bold">Command:</strong></p><div class="code-block-wrapper" style="width:60%"><div class="code-block-header">Bash</div><pre class="slate-CodeBlockElement slate-code_block"><code class="language-bash keep-markup drop-tokens"><div class="slate-code_line">theneo version [options] [command] <action></div><div class="slate-code_line"></div></code></pre></div><p class="slate-p " ><strong class="slate-bold">Options:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">-h, --help</code>: Display help for the command.</div></li></ul><p class="slate-p " ><strong class="slate-bold">Subcommands:</strong></p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">List Project Versions</div></li></ol><div class="code-block-wrapper" style="width:60%"><div class="code-block-header">Bash</div><pre class="slate-CodeBlockElement slate-code_block"><code class="language-bash keep-markup drop-tokens"><div class="slate-code_line">theneo version list [options]</div></code></pre></div><p class="slate-p " >Use this command to list all versions of a project.</p><p class="slate-p " ><strong class="slate-bold">Example:</strong></p><div class="code-block-wrapper" style="width:60%"><div class="code-block-header">Bash</div><pre class="slate-CodeBlockElement slate-code_block"><code class="language-bash keep-markup drop-tokens"><div class="slate-code_line">theneo version list --projectSlug my-project</div></code></pre></div><p class="slate-p " ></p><p class="slate-p " >2. Create Project Version</p><div class="code-block-wrapper" style="width:60%"><div class="code-block-header">Bash</div><pre class="slate-CodeBlockElement slate-code_block"><code class="language-bash keep-markup drop-tokens"><div class="slate-code_line">theneo version create [options]</div></code></pre></div><p class="slate-p " >This is the same as the <code class="slate-code">theneo version create</code> command described above.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p slate-indent-0" style="0px">3. Delete Project Version</p><div class="code-block-wrapper" style="width:60%"><div class="code-block-header">Bash</div><pre class="slate-CodeBlockElement slate-code_block"><code class="language-bash keep-markup drop-tokens"><div class="slate-code_line">theneo version delete [options]</div></code></pre></div><p class="slate-p slate-indent-0" style="0px">Use this command to delete a specific project version. Further options for deleting a version would be detailed in the help command for delete.</p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Example:</strong></p><div class="code-block-wrapper" style="width:60%"><div class="code-block-header">Bash</div><pre class="slate-CodeBlockElement slate-code_block"><code class="language-bash keep-markup drop-tokens"><div class="slate-code_line">theneo version delete --projectSlug my-project --versionSlug v1.0</div></code></pre></div><p class="slate-p " ></p><p class="slate-p slate-indent-0" style="0px">4. Help for a Specific Command</p><div class="code-block-wrapper" style="width:60%"><div class="code-block-header">Bash</div><pre class="slate-CodeBlockElement slate-code_block"><code class="language-bash keep-markup drop-tokens"><div class="slate-code_line">theneo version help [command]</div></code></pre></div><p class="slate-p " >Use this command to display help information for a specific subcommand.</p><p class="slate-p " ><strong class="slate-bold">Example:</strong></p><div class="code-block-wrapper" style="width:60%"><div class="code-block-header">Bash</div><pre class="slate-CodeBlockElement slate-code_block"><code class="language-bash keep-markup drop-tokens"><div class="slate-code_line">theneo version help create</div></code></pre></div><p class="slate-p " ></p><p class="slate-p " ></p>

Theneo CLI now includes commands to facilitate robust version management for your projects. This guide provides detailed instructions on using the new project version commands and options.

For detailed instructions on using the Theneo CLI tool, click 

To create a new version of your project, use the 

 command. This command allows you to specify various options such as the version name, project slug, workspace slug, and the previous version to duplicate content from.

 command encompasses various actions related to project versions. These include listing, creating, and deleting project versions.

Use this command to list all versions of a project.

Use this command to delete a specific project version. Further options for deleting a version would be detailed in the help command for delete.

Use this command to display help information for a specific subcommand.

API Versioning for Theneo CLI

<p class="slate-p " >Theneo's Schema Editor is an advanced feature within Theneo's documentation platform that provides you with the capabilities to directly update and manage your API schema from within the editor. This feature enhances the documentation process by enabling batch updates across your documents and ensuring consistency with error-checking mechanisms.</p><h3 class="slate-h3 " >Key Advantages</h3><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Batch Updates</strong></span>:</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Quickly implement changes across your entire documentation with a few clicks.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Discrepancy Detection</strong></span>:</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Easily spot inconsistencies or errors in your schema definitions across different sections.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Unified Documentation</strong></span>:</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Ensure that your API schema remains consistent throughout all documents.</div></li></ul></li></ol><h3 class="slate-h3 " >Step-by-Step Guide to Using the Schema Editor</h3><p class="slate-p " ></p><div style="text-align:left"><a href="https://theneo-prod-public.s3.us-east-1.amazonaws.com/images-1705963783683.png" target="_blank" rel="noreferrer"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/images-1705963783683.png" style="width:auto;height:100%" /></a></div><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Navigating to Schemas</strong></span>:</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">In the Theneo editor, click on the 'Schemas' section.</div></li><li class="slate-li " ><div style="position:relative">You'll see a list of schema elements such as objects, arrays, etc.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Editing Schemas</strong></span>:</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Click on any schema element you wish to modify.</div></li><li class="slate-li " ><div style="position:relative">Here you can add new fields, edit existing ones, or remove unnecessary fields.</div></li><li class="slate-li " ><div style="position:relative">Any changes you make will be reflected across all sections where the schema is used.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Tracking Usage</strong></span>:</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Go to the 'Sections' tab to see a list of all the instances where the schema is mentioned.</div></li><li class="slate-li " ><div style="position:relative">This allows you to understand the scope of the schema throughout your documentation.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Resolving Discrepancies</strong></span>:</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Click on 'Differences' to view discrepancies within your schema usage.</div></li><li class="slate-li " ><div style="position:relative">For example, if a field is marked as 'number' in one section and 'integer' elsewhere, this feature will highlight it.</div></li><li class="slate-li " ><div style="position:relative">You can then choose the correct definition and click 'Make as default' to update this across all sections.</div></li></ul></li></ol><p class="slate-p " ></p><div style="text-align:left"><a href="https://theneo-prod-public.s3.us-east-1.amazonaws.com/images-1705963824637.png" target="_blank" rel="noreferrer"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/images-1705963824637.png" style="width:auto;height:100%" /></a></div><h3 class="slate-h3 " >Addressing Discrepancies with the Schema Editor</h3><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Identifying Issues</strong></span>:</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">The 'Differences' feature will display fields with mismatched definitions, missing fields, or inconsistent descriptions.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Making Default Decisions</strong></span>:</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">After identifying the most accurate schema definition, you can standardize it by setting it as the default.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Automatic Merging</strong></span>:</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Once you 'Make as default', Theneo will automatically merge and update the schema across all relevant sections.</div></li></ul></li></ol><p class="slate-p " ></p><p class="slate-p " ></p><div style="width:60%;
	min-width:60%;" 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 " >This feature is currently available to our ​beta Growth package users​. If you're interested in exploring the Schema Editor, please let us know, and we’ll activate it for your account</p></div></div><p class="slate-p " ></p><p class="slate-p " ></p>

Theneo's Schema Editor is an advanced feature within Theneo's documentation platform that provides you with the capabilities to directly update and manage your API schema from within the editor. This feature enhances the documentation process by enabling batch updates across your documents and ensuring consistency with error-checking mechanisms.

Step-by-Step Guide to Using the Schema Editor

Addressing Discrepancies with the Schema Editor

<p>Theneo supports developers with a suite of integrated tools that streamline the API documentation and development process. From source code management to real-time collaboration, these tools enhance productivity and foster a more efficient workflow.</p><h3>Theneo’s Developer Tools Include:</h3><ul><li><div><strong>GitHub Actions Integration</strong>&lt;</div></li></ul>

Theneo supports developers with a suite of integrated tools that streamline the API documentation and development process. From source code management to real-time collaboration, these tools enhance productivity and foster a more efficient workflow.

Below you'll find details on the Bitbucket Integration and how you can make the most of it within your Theneo project.

<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>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>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><a href="https://theneo-dev-public.s3.us-east-1.amazonaws.com/9279c0b0-329f-477b-81d6-0ab122a6a987.webp" target="_blank"></a></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><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 -> admin tab.</div></li><li class="slate-li " ><div style="position:relative">Select "Convert as corporate" 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'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'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 "link" option within the Theneo editor'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 "Enter".</div></li></ul><p class="slate-p " >By following these steps, you'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'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 "General" 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 "SEO management" 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'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:60%;
	min-width:60%;" data-type=warning ><div ><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'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 "History" 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've located it, click to restore.</div></li></ul><p class="slate-p " ></p><div style="width:60%;
	min-width:60%;" 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 " >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: