Create an API key for your applications#
API keys are our recommended method to authenticate your software and scripts with our API endpoints.
Your applications can send the secret portion of an API key with each API request to authenticate as a machine-user and interact with all processing relevant endpoints on behalf of your organization.
Create an API key#
Step 1: Log into the API Hub#
… if you haven't already
Step 2: Navigate to the API Keys section#
… and click ⊕ New API key.
Step 3: Fill in the form#
You should give your new API key a descriptive name. This will help you identify and differentiate API keys later on. For security reasons, it is mandatory to set an expiration date (API keys will automatically deactivate on the given day at 00:00:00 UTC).
Step 4: Save your API key secret in a safe place#
Immediately after its creation, the secret token of your new API key is displayed to you exactly once.
We don't store this secret and thus it can't be restored later on. Make sure to immediately save it in a secure place, e.g. using a Password Manager of your choice.
Everyone with access to the API key secret can use the natif.ai APIs on behalf of your organization. It should thus generally be handled with the same care as other login credentials.
If you lose or forget to save the secret there is no way to restore it. However you can just easily create another API key anytime.
Use a short expiry to limit the risk of lost or stolen API keys to a shorter period of potential misuse. In case of doubt, any API key can always be revoked immediately via the web interface.
Step 5: Done #
The API key secret is enough to authenticate your services and scripts with our APIs. You're ready now to fire your first API requests!
If you want to quickly test your secret, you can do so with the following shell command: