EDITOR
...
Editor Blocks
API docs blocks

API endpoints

2min

We also recognize that not all companies provide standardized APIs, so we built an in-house widget to let you describe to your team or customers what your API looks like.

Additionally, it's super useful when working together with outside teams, where you need to communicate an API specification, and instead of providing a JSON file, you provide a document with this widget, and let it describe anything from URL, Parameters, Cookies, Request structure, Response structure, etc.

You can add one by typing (api) in the editor or clicking the API icon in a new row.




It's VERY flexible letting your team describe in detail any type of HTTP endpoint.

We're also working on making it interactive, so your customers can actually make the request from here.

🤔
Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.