Skip to main content

Okareo API Token

Authentication with Okareo Tokens​

To securely access the Okareo API and utilize the SDKs or CLI, you will need an Okareo API Token. Tokens are unique identifiers that authenticate your requests and ensure that only authorized users can interact with your Okareo resources. Your Okareo token acts as a secure key. You will typically include this token in the headers of your API requests or configure it within the SDKs/CLI to authenticate your session. Keep your token confidential, just like a password. Refer to the specific documentation for each SDK, CLI, or the REST API for detailed instructions on how to obtain and use your Okareo token for authentication

Setting up your Okareo environment​

Okareo requires an API Token. To provision an API token, you will need to sign-up with Okareo and then visit the Account Settings to get a token.
Once you have a token, we suggest making it available to your Jupyter environment.
An easy way to do this is through a .env file in VSCode or by making the Okareo token available as an envar.

  1. Login to app.okareo.com
  2. Expand User and Org Settings on the bottom left, navigate to API Tokens.
    Okareo Diagram
  3. Create a token by selecting Generate Token and completing the form.
    Okareo Diagram
  • ⚠️ API tokens are only visible once. Copy it to a secure location.
  • Tokens can have expiration dates for security.
  • The available role is Admin (for now).