API Endpoints

We also recognize that many companies are not providing standardised APIs, so we've built an in-house widget to let you describe to your team or customers how your API looks like.
It is also very useful when working together with outside teams, where you need to communicate an API specification, 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.
You can add one by typing (api) in the editor or clicking the API icon on a new row in the editor.
﻿
This endpoint allows you to get free cakes.
POST
Params
Path Params
id
required
String
ID of the cake to get, 
 for free of course.
Query Parameters
recipe
required
String
The API will do its best to find 
 a cake matching the provided recipe.
gluten
required
String
Whether the cake should be 
 gluten-free or not.
Header Parameters
X-Auth-Token
required
String
Authentication token to track 
 down who is emptying our stocks.
JS
Node.js
Curl
Python
Ruby
fetch("https://api.cakes.com/v1/cakes/:id", {
  "method": "POST",
  "headers": {
    "Accept": "application/json"
  }
})
.then(response => {
  console.log(response);
})
.catch(err => {
  console.error(err);
});
fetch("https://api.cakes.com/v1/cakes/:id", {
  "method": "POST",
  "headers": {
    "Accept": "application/json"
  }
})
.then(response => {
  console.log(response);
})
.catch(err => {
  console.error(err);
});
Responses
200
404
{
    "name": "Cake's name",
    "recipe": "Cake's recipe name",
    "cake": "Binary cake"
}
{
    "name": "Cake's name",
    "recipe": "Cake's recipe name",
    "cake": "Binary cake"
}
﻿
﻿
Add a new cake
PUT
Params
Body Parameters
id
required
String
ID of the cake to get
JS
Text
fetch("https://api.cakes.com", {
  "method": "GET",
  "headers": {
    "Accept": "application/json"
  }
})
.then(response => {
  console.log(response);
})
.catch(err => {
  console.error(err);
});
fetch("https://api.cakes.com", {
  "method": "GET",
  "headers": {
    "Accept": "application/json"
  }
})
.then(response => {
  console.log(response);
})
.catch(err => {
  console.error(err);
});
Responses
100
200
404

﻿
It's VERY flexible, letting your team describe any type of HTTP endpoint, in detail.
We're also working to make it interactive, so your customers can actually make the request from here.
Updated 02 Nov 2023
Did this page help you?
API Docs Blocks
OpenAPI / Swagger Block
Docs powered by Archbee
TABLE OF CONTENTS