Full reference

API keys

Create a dedicated application key, store it securely, and use its ID to inspect or revoke it. A key’s secret value is shown only when it is created.

Updated

Reviewed against Console v0.2.2. Available actions depend on project access and runtime configuration; check your installed CLI version for command differences.

Find keys for the selected project

  1. Select the intended organisation/project in the top bar.
  2. Open Settings → Project → API keys. Use an existing appropriate key or create a dedicated application key.
  3. Store the secret in your application environment. Check project attribution with one request and its trace.

Overview → Send a request also provides a project-bound onboarding flow. Do not create a new key for each test. Creating a key grants access; viewing the page does not.

Create a key for the application

bash
stimulir keys create --name support-service --save

Use a name that identifies the workload. --save stores the key for CLI inference; a deployed application still needs the key in its own secret configuration. Optional expiry and spend limits constrain the credential.

Inspect keys

bash
stimulir keys list

The list describes credentials; it does not recover their secret values. Use the exact key ID for management operations. Configure STIMULIR_API_KEY and the application’s project context as described in Authentication.

Rotate and revoke deliberately

Create a replacement, update the application, verify a request with the replacement, then revoke the old key. Revocation prevents continued use of that credential. Never include a key value in a public issue, screenshot, URL or support message. If a key was exposed, treat it as compromised even after deleting the message.

Command catalogue

Expand a command for its arguments. These commands follow the released CLI source; check stimulir --version and the command’s --help for your installation. Required flags are marked; some operations also validate combinations of inputs.

stimulir keys create

Create an API key — the plaintext key is shown exactly once.

--name, -n required
Human-readable key name.
--env
Key environment.
--expires-in-days
Expire the key after N days.
--credit-limit-pence
Spend cap in pence.
--save
Store the key in ~/.stimulir/credentials.json for stimulir infer.
--json
Emit raw JSON output.
stimulir keys list

List API keys in the active workspace.

--include-revoked
Include revoked keys.
--json
Emit raw JSON output.
stimulir keys revoke

Revoke an API key (irreversible).

key_id required
Positional argument. API key id (from stimulir keys list).
--yes, -y
Skip the confirmation prompt.
--json
Emit raw JSON output.