API Documentation URL in Odoo 19 : Runtime Documentation
Overview
Odoo 19 introduces a new Runtime Documentation feature that provides developers with comprehensive API documentation directly within the Odoo instance. This feature addresses common challenges faced when working with Odoo's JSON-RPC API by offering detailed model information and method syntax documentation.
Purpose
The feature serves as a centralized resource for developers who need to:
Understand Odoo's data model structure
Implement JSON-RPC API integrations
Access precise method calling syntax
Reference field definitions and relationships
Navigation
Navigate to your Odoo 19 instance
Ensure you are logged in with appropriate permissions
Remove / odoo from URL and Append /doc to your instance URL
The documentation interface will load automatically
This is the Odoo Runtime documentation, which offers features such as adding an API key and toggling between light and dark modes. Let's explore these features by referring to the models listed in the image above.
Here, when we choose the Account model, we can see the fields, methods, API requests, and responses related to the model.
How To Generate the API Key
To generate the key, first click on your user icon at the top-right corner and select 'My Profile' from the dropdown menu.
From the profile of the logged-in user, navigate to the 'Account Security' tab to create a new API key.
To create the key, you must first enter the password of the logged-in user.
To generate the key, first enter a name for the key and then click the 'Generate' button.
Click the 'Generate' button to create the key. The generated key will be displayed in a separate wizard.
Copy the key, paste it into the Odoo Runtime Doc view, and save the changes.
After saving, you can run an API request directly from the Odoo documentation, and the response will be displayed immediately below
In this Runtime Documentation, if we search for a model, field name, or anything else, its related models, fields, and methods are listed in the search results using the ‘Find anything..’ option at the top.
