Getting an API Key

There are a few things you will need, you will need to have a Karia account(either demo or production), and ideally access to a Karia Organisation and Workspace.

Creating your first API Key.

1. Go to the Karia Portal and login with your karia account.

2. You will need to navigate to your User Profile.

3. Navigate to the Developer menu item.

4. There will be a button to create a new API Key. You will also be able to view and revoke your existing API Keys. When creating your key you can select the permissions/scope of the key you want to create.

   • You will need to give the key a name.
   • You will need to set the expiry for the key. (We recommend 90 days with keys being rotated.)
   • You will need to select the permissions/scope of the key you want to create or select all of them.

5. Click create and you will be presented with your new API key

This key will be only displayed once, so make sure to copy it down.

Authentication Header

x-api-key: your-api-key

Example Request

curl -X GET "http://localhost:3000/api/utils/health" \
  -H "x-api-key: your-api-key"

Next Steps

1. Verify connectivity with the Utilities guide.
2. Continue to Quick Start for a recommended onboarding path.
3. Use the OPENAPI reference for endpoint-level authentication and schema details.