8min

Web API

🍀(hopefully) helpful note:

We created a simple React app implementation on GitHub for helping people with an quicker/easier implementation. Link here: https://github.com/Kaedim/API_Implementation

Step 1: Registering a webhook

To register a webhook endpoint you will need your API key and developer ID, both which can be found under your user setting page inside the Kaedim platform. Your API key should always be provided in the X-API-Key Header in your post requests.

Get a cake by its ID
GET
Code examples
Params
Node.js
|
200
201
400
404
|

Upon successful authentication you will receive a JWT which needs to be added as a Bearer Token header on all processing requests. You will also receive a refreshToken to be used to generate a new JWT. Your JWT will expire after 12 hours, see below for how to refresh your token.

Step 2: Processing an image

All processing requests must include the JWT in the Bearer Authorization header, alongside your API-key, and your devID inside the request body. We also suuport high detail requests using the highDetail parameter.

Get a cake by its ID
GET
Code examples
Params
Node.js
|
201
400
|

Once the asset has been successfully generated, a download url will be sent to the registered webhook endpoint.

Please note that you will need to perform a GET request on the url’s to get the file containing the completed asset.

Each completed asset is available in 4 supported formats obj, fbx, glb, gltf, all of which have seperate download links in the post request. Download links expire after an hour. We also provide functionality to fetch all requests, see below.

Upon successful generation you will receive a response similar to the following:

201
400
|

Asset creation may fail due to various reasons some of which include: complexity, visibility of object, multiple objects in the scene, inappropriate content etc. Please see our guidelines for more information.

Other useful routes

Get a cake by its ID
GET
Code examples
Params
Node.js
|
200
400
|

Refreshing a JWT

Your web token will expire after 12 hours from it’s creation. You can only have one JWT valid at a time, therefore creating a new JWT will automatically invalidate the old token. To get a new JWT you must use the refresh token generated at webhook registration. You can find refresh token in user settings in the kaedim platform next to the api-key.

Get a cake by its ID
GET
Code examples
Params
Node.js
|
200
400
|

Error Codes

We use normal HTTP codes to indicate the success or failure of your API requests. If your request fails, Kaedim will return an appropriate error message.

Error responses

Field Name

Type

Description

status

String

Short string describing the status of the request. Generally "success" or "error".

message

String

Short human-readable string giving more context on the reason the error occurred.

cause

Optional <object>

Optional cause of the error, for example if the request image has been denied for a specific reason.





Updated 19 Apr 2022
Did this page help?
Yes
No