API Keys

API keys authenticate the CLI, the public REST API, the MCP server, the n8n node, and webhooks. These commands let you manage the keys for your current workspace.

settings:api-keys

List all API keys for your workspace. Only metadata is returned (id, name, key prefix, creation date) — the full secret is never shown after creation.

so-me settings:api-keys

Examples

# All keys as JSON
so-me settings:api-keys

# Compact table
so-me settings:api-keys --table

# Map each key name to its ID
so-me settings:api-keys | jq -r '.[] | "\(.id)\t\(.name)"'

settings:create-api-key

Create a new API key. The full key is printed once on success and then only metadata (id, name, keyPrefix, createdAt) is shown — it is not stored and cannot be retrieved again.

so-me settings:create-api-key --name <name>

Option	Description
`--name <name>`	Key name (required)

Examples

# Create a key for CI
so-me settings:create-api-key --name "ci-pipeline"

# Create a key for a teammate's local machine
so-me settings:create-api-key --name "jane-laptop"

Output

  API key created

  Save this key — it will not be shown again:

  sk_live_xxxxxxxxxxxxxxxxxxxxxxxx

  { "id": "...", "name": "ci-pipeline", "keyPrefix": "sk_live_xxxx", "createdAt": "..." }

The full API key is shown only once, immediately after creation. Copy it somewhere secure (a secret manager or environment variable). If you lose it, revoke the key and create a new one.

settings:revoke-api-key

Revoke an API key by its ID. By default a confirmation prompt is shown; pass -y/--yes to skip it. Once revoked, any client using that key will be rejected.

so-me settings:revoke-api-key <id> [options]

Argument / Option	Description
`<id>`	API key ID (required)
`-y, --yes`	Skip the confirmation prompt

Examples

# Interactive (prompts for confirmation)
so-me settings:revoke-api-key 550e8400-e29b-41d4-a716-446655440000

# Non-interactive (for scripts)
so-me settings:revoke-api-key 550e8400-e29b-41d4-a716-446655440000 --yes

# Find a key by name, then revoke it
ID=$(so-me settings:api-keys | jq -r '.[] | select(.name=="ci-pipeline") | .id')
so-me settings:revoke-api-key "$ID" --yes

Getting Started

Publishing

AI Studio

Inbox & Engagement

Analytics

Biolink

Team & Collaboration

Settings & Billing

Webhooks

Support

settings:api-keys

settings:create-api-key

settings:revoke-api-key

​settings:api-keys

​settings:create-api-key

​settings:revoke-api-key

settings:api-keys

settings:create-api-key

settings:revoke-api-key