How do I generate an API key?

This article explains how easy it is for you to generate a new API key

A lot of times, you will find yourself needing to use our API. Whether you want to upload new scenes, create new batches, or even start a new project, you can do all of that through our API.

But to start using it, you'll first need to generate an API key! 🔑

How to generate a new API key

  1. Log in to our platform. You can find the login page here

  2. Once logged in, click on the drop-down under your profile picture and select the option: API Credentials...
  3. After clicking on API Credentials, click on Generate Credentials. This will start the process of generating a new API key for you.Screenshot 2024-07-31 at 11.33.29
  4. Make sure you give a clear name to your new key.Screenshot 2024-07-31 at 11.33.43
  5. Great! You've finally generated your new API credentials 🥳🥳! Now you can choose between copying the credentials, or downloading them.

    Screenshot 2024-07-31 at 11.33.58

ATTENTION: Make sure you download or copy your credentials before you click "Close" since you won't be able to retrieve them again.

What if I lose my API key?

There are several reasons why we might end up losing our API key. If this happens, it's important to understand that this key cannot be recovered.

To resolve this, you will need to generate a new API key.

I have an API key but I can't access any resources, why is that?

The truth is that this issue can have multiple root causes. However, in most cases, we highly recommend deleting your current key and generating a new one. If you still encounter difficulties accessing your resources, please contact us at support@kognic.com.

Why do I keep having a 403 error every time I make an API call?

This error usually indicates that your account does not have sufficient permissions to access that specific resource. To fix this, you will need to contact our support team at support@kognic.com.

If you are unsure how to create a bug report you can read this article.

Can I generate multiple keys?

Yes! You can generate as many keys as you would like.

 

If you  encounter any issues during this process, don't hesitate to contact our support team at support@kognic.com 🏆