Primordial SDK
Login

Evaluation Keys

Unlock meaningful Debug evaluation.

Evaluation keys are account-backed, app-scoped credentials that let you use SDK features while developing and testing registered apps.

Quick Start

Creating an evaluation key is simple. First, create a developer account from the developer console and verify your email address. Once your account is ready, log in and follow these steps.

  1. Create a project.
  2. Register an app inside the project. A project can have multiple apps.
    1. Registering an app requires the app ID, bundle ID, or package name you use in your app project.
    2. Once the app is registered, an evaluation key is generated immediately for that app.
    3. If you are building for multiple platforms, add the identifier for each platform.

Evaluation keys are not production licenses. They expire after 30 days, can be rotated, and can be revoked when app access changes.

If your evaluation key is not working, rotate it to generate a new one, then double-check that you provided the correct case-sensitive identifier for each platform.

App Identifiers

App identifiers connect an evaluation key to the app builds that are allowed to use it. Add the exact bundle ID or package name for each platform you want to test. App identifiers are case sensitive.

You can manage, add or remove identifiers later in App's detail view. When you remove an identifier, builds using that identifier stop working with the evaluation key. If you remove all identifiers for an app, the active evaluation key is revoked.

Copy And Rotate

Copy the evaluation key when it is shown in the console. For safety, existing keys are masked after you leave the app detail view. Rotate the key when you need a fresh copy or want to revoke the old key.

Rotating an evaluation key immediately revokes the old key and generates a new one for the same registered app and identifiers.

Using Evaluation key

Make sure to call evaluation jey activation before using any feature of SDK. During activation, the SDK checks for a valid evaluation key and associated app identifiers. If the evaluation key is valid, the SDK unlocks the features allowed for evaluation usage. 

import Primordial

try await Primordial.activate(
    .evaluationKey("pk_eval_...")
)

Evaluation Key Metadata

Evaluation activation can send limited SDK and app metadata so we can validate and understand which developers are trying the SDK, what they are building, and where Primordial is useful. We do not collect prompts, model inputs, outputs, files, or private app data.

These are the metadata fields that can be sent during evaluation activation:

Evaluation key ID Identifies the evaluation key used for activation.
Project ID Connects evaluation activity to your developer project.
Registered app ID Connects activation to the app registered in the developer console.
SDK version Helps us understand which SDK build is being tested.
Platform Identifies the platform selected for the app identifier.
OS version Helps diagnose platform compatibility during evaluation.
App identifier Matches the bundle ID or package name used by the app.
Build context Confirms the SDK is being used in a development or testing build.
Feature Shows which SDK capability is being evaluated.