API keys
Create a scoped key for programmatic access, rotate it, and revoke it.
Manage API keys for programmatic access. A key lets something other than the AODex interface act on your account, with only the permissions you grant it.
Before you start: be deliberate about scope. A key with Full access can do anything you can, and unlike your password it tends to end up in configuration files and scripts.
Creating a key
Create API Key — an account with none shows No API Keys and Create an API key to get started.
| Field | Notes |
|---|---|
| Name | How you will recognise it later. Name it for the thing that will use it, not for yourself. |
| Expiration | A date, or No expiration. Prefer a date. |
| Permissions | The scopes below. Grant the narrowest set that works. |
Permissions
| Scope | Allows |
|---|---|
| Read conversations | List and read your threads. |
| Create & edit conversations | Create threads and change them. |
| Send messages | Send into a conversation. |
| Read messages | Read message content. |
| Read personas | List your personas. |
| Read projects | List your projects. |
| Read notifications | Read your notifications. |
| Read usage data | Read usage figures. |
| Full access | Everything above, and anything added later. |
Copy the key now. You will not be able to see it again. AODex shows the secret exactly once, at creation. If it is lost, rotate or delete the key and issue a new one — there is no way to retrieve it.
Rotating
Rotate API Key issues a new secret while keeping the key’s identity, name and permissions. AODex confirms with Key Rotated — and the new secret is shown once, under the same rule as above.
Rotate rather than delete-and-recreate when something else references the key by name, or when you want continuity in whatever tracks its use.
Revoking
Delete API Key removes it permanently. Anything using it stops working immediately, which is the point.
Under Active API keys you can see what is live, with Expires
A note on the other key
The AOCyber API key that came with your subscription is a different thing, managed in your AOCyber account under Manage subscription & billing. Keys created here are AODex account keys.