API Token

Your Okareo API token authenticates all requests to Okareo—whether you use the SDKs, CLI, REST API, or the proxy for monitoring. This page gets you from sign-up to a working token in a few minutes.

Get your token

1. Sign up for Okareo if you don’t have an account.
2. Log in at app.okareo.com, open User and Org Settings (bottom left), and go to API Tokens.
3. Click Generate Token, complete the form, and copy the token.

Copy it once

API tokens are shown only at creation time. Store your token securely (e.g. in a password manager or secret store). You can create additional tokens later if needed.

For step-by-step instructions and screenshots, see API Token (Reference).

Set your environment

Use the OKAREO_API_KEY environment variable so the SDK and CLI pick up your token automatically:

export OKAREO_API_KEY="your_token_here"

Or add it to a .env file in your project (and ensure .env is in .gitignore).

Verify with the SDK

After setting OKAREO_API_KEY, you can confirm everything works with a minimal SDK call:

Python

import os
from okareo import Okareo

okareo = Okareo(os.environ["OKAREO_API_KEY"])
print("Projects:", okareo.get_projects())

TypeScript

import { Okareo } from "okareo-ts-sdk";

(async () => {
    const okareo = new Okareo({ api_key: process.env.OKAREO_API_KEY ?? "" });
    const projects = await okareo.getProjects();
    console.log("Projects:", projects);
})();

If you see your projects (or an empty list for a new account), authentication is working.

Next steps

• Getting Started — Run your first evaluation and set up monitoring.
• Reference: API Token — Token lifecycle, expiration, and roles.
• CLI — Use your token with the Okareo CLI and config.