Bloom

Get Started

Introduction

Theneo API documentation

Customizing

Theneo web editor

Rest API Reference

Create customer

Update customer

Retrieve customer

List all customers

Delete customer

Blank

Theneo Sample Project

Theneo Documentation

Production

Sandbox

<p class="slate-p slate-indent-0" style="0px">Theneo is the quickest, simplest way to generate high-quality, interactive API docs. Unlock the full potential of AI-powered API documentation: Create stunning, low-maintenance, and engaging docs with a single upload. Theneo streamlines every step of the process, ensuring that your documentation is not only comprehensive but also interactive and user-friendly. </p><a href="https://app.theneo.io/theneo/quickstart/theneo-quickstart-guide" target="_blank" class=card-anchor><div class="card-box" style="width:100%;"><img src=https://cdn.jsdelivr.net/npm/emoji-datasource-apple/img/apple/64/1f680.png class=card-icon></img><div ><h3 class="slate-h3 " >Just getting started?</h3><p class="slate-p " >Check out our <a href="https://app.theneo.io/theneo/quickstart/theneo-quickstart-guide" target="_self">Quickstart Guide</a></p></div></div></a><p class="slate-p " ></p><div class="steps-widget" style="width:100%;
  	min-width:100%;"><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >1</h6><h3 class="slate-h3 " >Uploading Your API Specification</h3><p class="slate-p slate-indent-0" style="0px">Theneo supports various API specs, like Swagger, OpenAPI, and GraphQL, with an easy upload process. If you don&apos;t have a spec, use our tools to create one from scratch</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >2</h6><h3 class="slate-h3 " >Selecting Your AI Co-pilot</h3><p class="slate-p slate-indent-0" style="0px">After uploading your API spec, use Theneo&apos;s AI Co-pilot to generate or enhance content. For a faster setup, click &apos;Quick Start&apos; to go straight to publishing.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >3</h6><h3 class="slate-h3 " >Setting Permissions</h3><p class="slate-p slate-indent-0" style="0px">Set your project&apos;s visibility and invite collaborators as needed. Start privately and go public when ready, managing settings anytime to match your development lifecycle.</p></div></div></div><p class="slate-p " ></p>

Theneo is the quickest, simplest way to generate high-quality, interactive API docs. Unlock the full potential of AI-powered API documentation: Create stunning, low-maintenance, and engaging docs with a single upload. Theneo streamlines every step of the process, ensuring that your documentation is not only comprehensive but also interactive and user-friendly. 

<p class="slate-p " >Theneo Sample documentation offers a glimpse into how you can manage your API documentation within the Theneo platform. It showcases the tools supported by Theneo and provides insights into the appearance of your API documentation.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p slate-indent-0" style="0px">Please note that this documentation serves as a demonstration and showcases how to effectively manage your API documentation within the Theneo platform. All mentioned endpoints and sections are purely for illustrative purposes.</p></div></div><h3 class="slate-h3 " >Generate API Documentation</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Build interactive API docs</div></li><li class="slate-li " ><div style="position:relative">Tailor you documentation</div></li><li class="slate-li " ><div style="position:relative">Create and launch quickly</div></li><li class="slate-li " ><div style="position:relative">Update easily within seconds</div></li><li class="slate-li " ><div style="position:relative">Built for everyone</div></li></ul><p class="slate-p " ></p><p class="slate-p " >Theneo&apos;s web editor boasts a variety of API management widgets, each designed to streamline the documentation process and enhance user experience. These widgets include:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Base URL:</strong> Define the root URL(s) for API requests.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Language Box:</strong> Specify the programming language used in your API documentation.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">API Endpoint Summary:</strong> Provide a concise overview of each API endpoint.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Object Example:</strong> Display sample representations of API objects.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Error Codes:</strong> Document possible error codes and their meanings.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Status Codes:</strong> Explain HTTP status codes and their significance.</div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " >Integrations</h3><p class="slate-p " >Import your collections manually or use our integrations to automatically migrate your work from:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Swagger</div></li><li class="slate-li " ><div style="position:relative">Postman</div></li><li class="slate-li " ><div style="position:relative">Github</div></li></ul><p class="slate-p " ></p>

Theneo Sample documentation offers a glimpse into how you can manage your API documentation within the Theneo platform. It showcases the tools supported by Theneo and provides insights into the appearance of your API documentation.

Theneo's web editor boasts a variety of API management widgets, each designed to streamline the documentation process and enhance user experience. These widgets include:

Import your collections manually or use our integrations to automatically migrate your work from:

<p class="slate-p slate-indent-0" style="0px">In Theneo, you have complete control over the look and feel of your documentation. This is achieved through an extensive set of color customization options that cater to every aspect of your project&apos;s interface. Here&apos;s a detailed overview of what you can configure:</p><p class="slate-p slate-indent-0" style="0px">General Settings:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Logos</strong></span>: Upload separate logos for light and dark modes, ensuring clear visibility regardless of theme. Ideal dimensions are provided for optimal display.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Favicon</strong></span>: Customize the small icon that appears in browser tabs and bookmarks to make your site easily identifiable.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Logo Hyperlink</strong></span>: Direct users to your desired URL through the logo in your documentation.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Attribution</strong></span>: Toggle the &quot;Powered by Theneo&quot; attribution on or off to match your branding preferences.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Document Font</strong></span>: Select from a variety of fonts to maintain consistency across your documentation.</div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " >Color Customization of the published view projects:</h3><p class="slate-p " >Global Settings:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Body Text</strong>: Set the text color for readability.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Section Headings: </strong>Highlight section titles.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Background:</strong> Choose a primary background color.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Accents:</strong> Customize borders and outlines.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Buttons:</strong> Define button colors.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Links:</strong> Customize hyperlink colors.
</div></li></ul><p class="slate-p " >Left Sidebar Menu:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Item Colors:</strong> Set colors for menu items and active selection.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Background:</strong> Choose a sidebar background color.</div></li></ul><p class="slate-p " ></p><p class="slate-p " >Widget Cards:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Code Snippet Card:</strong> Customize the header and body colors for request, response, and object example cards.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Base URL Card:</strong> Set header and body background colors.</div></li></ul><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p><h3 class="slate-h3 " >Custom CSS and JavaScript</h3><p class="slate-p " >Custom CSS and JavaScript offer powerful tools to personalize and enhance your Theneo documentation, giving you full control over its appearance and functionality. This feature allows you to create a highly branded, interactive, and tailored user experience.</p><p class="slate-p " ></p><h4 class="slate-h4 " >Benefits:</h4><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Enhanced Personalization</strong>: Customize the visual style to perfectly align with your brand.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Extended Functionality</strong>: Implement advanced features or third-party integrations using JavaScript.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Improved User Experience</strong>: Optimize layout, navigation, and interactions for a more user-friendly and branded interface.</div></li></ul><p class="slate-p " ></p>

In Theneo, you have complete control over the look and feel of your documentation. This is achieved through an extensive set of color customization options that cater to every aspect of your project's interface. Here's a detailed overview of what you can configure:

Color Customization of the published view projects:

Custom CSS and JavaScript offer powerful tools to personalize and enhance your Theneo documentation, giving you full control over its appearance and functionality. This feature allows you to create a highly branded, interactive, and tailored user experience.

<p class="slate-p " >Theneo&apos;s web editor is a rich and intuitive platform, equipped with a variety of widgets that enrich the documentation experience. These widgets add depth and clarity to your API documentation, making it more engaging and informative. You can easily access these widgets by simply going to a new line in the editor and typing /, which brings up the widget options.</p><p class="slate-p " >Additionally, Theneo&apos;s live collaboration feature enables real-time teamwork, allowing multiple users to simultaneously edit, comment, and review documentation. This streamlines the editing process, reduces bottlenecks, and fosters seamless collaboration across teams. Whether you&apos;re working in the same room or across different time zones, live collaboration ensures that everyone stays aligned and up to date on changes.</p><p class="slate-p " >Let&apos;s take a look at the widgets available:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Code Blocks</strong></span>: Perfect for displaying code snippets, helping users und/erstand implementation details in different programming languages.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Divider</strong></span>: A simple yet effective tool to create clear separations between sections, enhancing readability and structure.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Callout</strong></span>: Draws focus to important information, tips, or warnings, ensuring key messages are not missed.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Table</strong></span>: Ideal for presenting data or information systematically, making complex details easier to digest.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Image &amp; Video</strong></span>: Brings your documentation to life with visual content like diagrams, screenshots, or explanatory videos, offering a richer understanding.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Object Example</strong></span>: Shows practical examples of objects used in your API, demystifying complex data structures for better comprehension.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Error Codes</strong></span>: Outlines potential errors that might occur, providing a guide for troubleshooting and error resolution.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Status Codes</strong></span>: Clarifies the HTTP status codes your API returns, giving insights into various responses and their meanings.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Base URL</strong></span>: Displays the base URL of your API prominently, a crucial starting point for users making API requests.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Language Box</strong></span>: Allows for multi-language documentation, offering code examples in various programming languages to cater to a diverse audience.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Request Widget</strong></span>: Demonstrates specific API requests, detailing parameters, headers, and other necessary request components.</div></li><li class="slate-li " ><div style="position:relative"><span style="color:var(--tw-prose-bold)"><strong class="slate-bold">Response Widget</strong></span>: Provides examples of API responses, helping users understand expected outcomes from their API interactions.</div></li></ul><p class="slate-p " ></p><p class="slate-p " >Each widget is tailored to enhance specific aspects of API documentation, making Theneo&apos;s web editor a versatile tool for developers and technical writers. As you proceed with documentation, these widgets can be seamlessly integrated to cater to your content needs, ensuring a comprehensive and user-friendly experience.</p>

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

Additionally, Theneo's live collaboration feature enables real-time teamwork, allowing multiple users to simultaneously edit, comment, and review documentation. This streamlines the editing process, reduces bottlenecks, and fosters seamless collaboration across teams. Whether you're working in the same room or across different time zones, live collaboration ensures that everyone stays aligned and up to date on changes.

Let's take a look at the widgets available:

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

<p class="slate-p " >Create customer allows users to add a new customer to the system, providing essential details such as name, email, address, and phone number. By utilizing this functionality, users can easily store and manage customer information for seamless transactions and interactions within the application.</p>

Create customer allows users to add a new customer to the system, providing essential details such as name, email, address, and phone number. By utilizing this functionality, users can easily store and manage customer information for seamless transactions and interactions within the application.

given_name

last_name

email_address

address

phone_number

The reference ID associated with the customer.

reference_id

Any additional notes or comments related to the customer.

note

The token or credentials required to authorize the request.

Authorization

The type of content included in the request or response.

Content-Type

The customer parameter contains details and information related to the newly created customer profile.

customer

The errors parameter provides information on any errors encountered during the customer creation process.

errors

<p class="slate-p " >Update customer allows users to modify and update customer information within the system. Users can easily adjust customer details such as name, email, phone number, and more. This section provides a seamless way to keep customer data accurate and up-to-date.</p><p class="slate-p " ></p><p class="slate-p " ></p>

Update customer allows users to modify and update customer information within the system. Users can easily adjust customer details such as name, email, phone number, and more. This section provides a seamless way to keep customer data accurate and up-to-date.

The given name or first name of the customer.

last_Name

email

password

The phone number associated with the customer.

phone

userStatus

The authorization token for accessing the API.

The type of content in the request or response.

customer_id

The customer parameter contains the updated information of the customer after the update request.

The errors parameter includes any error messages or issues encountered during the customer update process.

<p class="slate-p " >This section allows users to retrieve detailed information about a specific customer within the system. Users can access essential details such as the customer's name, email address, phone number, address, and creation source. By utilizing this functionality, users can efficiently manage customer data and preferences.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

This section allows users to retrieve detailed information about a specific customer within the system. Users can access essential details such as the customer's name, email address, phone number, address, and creation source. By utilizing this functionality, users can efficiently manage customer data and preferences.

Header parameter for authorization to access the customer information.

Header parameter specifying the content type of the response.

Path parameter representing the unique identifier of the customer.

<p class="slate-p " >This section allows users to retrieve a list of all customers associated with the project. By accessing this data, users can gain insights into their customer base, track customer interactions, and manage customer information effectively within the project.</p><p class="slate-p " ></p><p class="slate-p " ></p>

This section allows users to retrieve a list of all customers associated with the project. By accessing this data, users can gain insights into their customer base, track customer interactions, and manage customer information effectively within the project.

Represents the email address associated with a customer.

Specifies a date and time for filtering customer records based on the creation datetime.

created

Contains the authentication credentials required to access the API.

Specifies the format of the data in the request or response.

Indicates the type of object being returned in the response.

object

Represents the URL associated with a customer.

Flag that indicates whether there are more customer records available.

has_more

Contains the data related to the customer records being returned in the response.

data

<p class="slate-p " >Deletes a customer from the system permanently, and this action cannot be reversed. Additionally, it promptly cancels any active subscriptions associated with the customer.</p><p class="slate-p " ></p><p class="slate-p " ></p>

Deletes a customer from the system permanently, and this action cannot be reversed. Additionally, it promptly cancels any active subscriptions associated with the customer.

This header parameter is used to authenticate the request and must contain a valid API key.

This header parameter specifies the media type of the request body, with the value typically set to "application/json".

This path parameter specifies the unique identifier of the customer to be deleted.

This response parameter specifies the unique identifier of the customer that was deleted.

This response parameter represents the JSON object returned upon successful deletion of the customer.

This response parameter indicates whether the customer was successfully deleted (true) or not (false).

Sections