Engineering Workspace

API Keys

Create and manage hyb_* keys that authenticate inference requests. Keys are scoped to the workspace and carry their own environment, limits, and expiry.

Endpoints

POST/api/v1/workspace/api-keys
GET/api/v1/workspace/api-keys
PATCH/api/v1/workspace/api-keys/{id}
DELETE/api/v1/workspace/api-keys/{id}

Platform endpoints authenticate with your session token and the X-Business-Profile-Id header.

Create a key

ParameterTypeDescription
namerequiredstringHuman-readable key name.
envrequiredstringEnvironment: prod, staging, or dev.
ip_allowliststring[]Optional list of IPs/CIDRs allowed to use the key.
credit_limit_penceintegerOptional spend cap for the key, in pence.
credit_limit_reset_periodstringHow often the credit limit resets.
expires_in_daysintegerOptional key lifetime; the key expires after this many days.
CLI
stimulir keys create --name ci-pipeline --env prod \
  --credit-limit-pence 50000 --expires-in-days 90

The response contains the plaintext hyb_* key exactly once. It is not stored in retrievable form — if you lose it, revoke the key and create a new one.

From the CLI

bash
stimulir keys create --name "ci-pipeline" --env prod
stimulir keys list
stimulir keys revoke <key-id>

Lifecycle

  • List — GET returns key metadata (never the plaintext secret).
  • Update — PATCH adjusts name, allowlist, and limits.
  • Revoke — DELETE immediately invalidates the key for inference.