Create an API key

POST/v1/api_keys

Mints a livemode secret key for the active org. The full `secret` is returned exactly once in this response and cannot be retrieved later — store it now.

Requires an API key (bearer), scoped to the active org. Supports idempotency keys.

Body parameters

namestringrequiredmax 120 chars
scopesarray of stringoptional
servicebooleanoptional
Mint a SERVICE key (a machine identity, no acting user). Default is a USER key that acts as the caller — its actions are authored as you (09 §3).
metadataobjectoptional
Arbitrary key/value map; merge-on-write (§6).

Returns

201The created key, including its one-time secret.

Failures use the standard error envelope with a closed set of codes.

Terminal

renza keys create "CI deploy key"

POST /v1/api_keys

curl https://api.renza.io/v1/api_keys \
  -H "Authorization: Bearer $RENZA_API_KEY" \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{
  "name": "CI deploy key",
  "scopes": [],
  "service": false
}'

TypeScript

import { createRenzaClient } from "renza-sdk";

const renza = createRenzaClient({ apiKey: process.env.RENZA_API_KEY! });

const key = await renza.apiKeys.create({
  name: "CI deploy key",
  scopes: [],
  service: false,
});

Response 201

{
  "id": "key_8KxQ2v…",
  "object": "api_key",
  "name": "CI deploy key",
  "prefix": "rza_sk_live_8KxQ2v",
  "last4": "aB3z",
  "mode": "live",
  "scopes": [],
  "kind": "user",
  "acts_as": "usr_1a2b…",
  "created_by": "usr_1a2b…",
  "last_used_at": null,
  "revoked_at": null,
  "created_at": "2026-06-19T10:30:00.000Z"
}