> ## Documentation Index
> Fetch the complete documentation index at: https://docs.so-me.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# API-Schlüssel

> API-Schlüssel für den programmatischen Zugriff in der CLI erstellen, auflisten und widerrufen

API-Schlüssel authentifizieren die CLI, die öffentliche REST-API, den MCP-Server, den n8n-Node und Webhooks. Mit diesen Befehlen verwaltest du die Schlüssel deines aktuellen Workspace.

## settings:api-keys

Listet alle API-Schlüssel deines Workspace auf. Es werden nur Metadaten zurückgegeben (ID, Name, Schlüsselpräfix, Erstellungsdatum) — das vollständige Secret wird nach dem Erstellen nie mehr angezeigt.

```bash theme={null}
so-me settings:api-keys
```

```bash Beispiele theme={null}
# Alle Schlüssel als JSON
so-me settings:api-keys

# Kompakte Tabelle
so-me settings:api-keys --table

# Jeden Schlüsselnamen seiner ID zuordnen
so-me settings:api-keys | jq -r '.[] | "\(.id)\t\(.name)"'
```

## settings:create-api-key

Erstellt einen neuen API-Schlüssel. Der vollständige Schlüssel wird bei Erfolg einmalig ausgegeben, danach werden nur noch Metadaten (`id`, `name`, `keyPrefix`, `createdAt`) angezeigt — er wird nicht gespeichert und kann nicht erneut abgerufen werden.

```bash theme={null}
so-me settings:create-api-key --name <name>
```

| Option | Beschreibung |
| - | - |
| `--name <name>` | Schlüsselname **(erforderlich)** |

```bash Beispiele theme={null}
# Einen Schlüssel für CI erstellen
so-me settings:create-api-key --name "ci-pipeline"

# Einen Schlüssel für den lokalen Rechner eines Teammitglieds erstellen
so-me settings:create-api-key --name "jane-laptop"
```

```text Ausgabe theme={null}
  API key created

  Save this key — it will not be shown again:

  sk_live_xxxxxxxxxxxxxxxxxxxxxxxx

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

> [!WARNING]
>
> Der vollständige API-Schlüssel wird nur ein einziges Mal direkt nach dem Erstellen angezeigt. Kopiere ihn an einen sicheren Ort (Secret-Manager oder Umgebungsvariable). Wenn du ihn verlierst, widerrufe den Schlüssel und erstelle einen neuen.

## settings:revoke-api-key

Widerruft einen API-Schlüssel über seine ID. Standardmäßig erscheint eine Bestätigungsabfrage; mit `-y`/`--yes` überspringst du sie. Nach dem Widerruf wird jeder Client abgewiesen, der diesen Schlüssel verwendet.

```bash theme={null}
so-me settings:revoke-api-key <id> [options]
```

| Argument / Option | Beschreibung |
| - | - |
| `<id>` | API-Schlüssel-ID **(erforderlich)** |
| `-y, --yes` | Bestätigungsabfrage überspringen |

```bash Beispiele theme={null}
# Interaktiv (fragt nach Bestätigung)
so-me settings:revoke-api-key 550e8400-e29b-41d4-a716-446655440000

# Nicht interaktiv (für Skripte)
so-me settings:revoke-api-key 550e8400-e29b-41d4-a716-446655440000 --yes

# Einen Schlüssel per Namen finden und dann widerrufen
ID=$(so-me settings:api-keys | jq -r '.[] | select(.name=="ci-pipeline") | .id')
so-me settings:revoke-api-key "$ID" --yes
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.