> ## 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.

# Chaves de API

> Crie, liste e revogue chaves de API para acesso programático pela CLI

As chaves de API autenticam a CLI, a API REST pública, o servidor MCP, o nó do n8n e os webhooks. Estes comandos permitem gerenciar as chaves do seu espaço de trabalho atual.

## settings:api-keys

Lista todas as chaves de API do seu espaço de trabalho. Apenas metadados são retornados (id, nome, prefixo da chave, data de criação); o segredo completo nunca é exibido após a criação.

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

```bash Exemplos theme={null}
# Todas as chaves em JSON
so-me settings:api-keys

# Tabela compacta
so-me settings:api-keys --table

# Mapear o nome de cada chave para o seu ID
so-me settings:api-keys | jq -r '.[] | "\(.id)\t\(.name)"'
```

## settings:create-api-key

Cria uma nova chave de API. A chave completa é exibida uma única vez em caso de sucesso; depois, apenas os metadados (`id`, `name`, `keyPrefix`, `createdAt`) são mostrados. Ela não é armazenada e não pode ser recuperada novamente.

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

| Opção | Descrição |
| - | - |
| `--name <name>` | Nome da chave **(obrigatório)** |

```bash Exemplos theme={null}
# Criar uma chave para CI
so-me settings:create-api-key --name "ci-pipeline"

# Criar uma chave para a máquina local de um colega
so-me settings:create-api-key --name "jane-laptop"
```

```text Saída 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]
>
> A chave de API completa é exibida apenas uma vez, logo após a criação. Copie-a para um lugar seguro (um gerenciador de segredos ou uma variável de ambiente). Se você a perder, revogue a chave e crie uma nova.

## settings:revoke-api-key

Revoga uma chave de API pelo ID. Por padrão, uma confirmação é solicitada; passe `-y`/`--yes` para ignorá-la. Depois de revogada, qualquer cliente que use essa chave será rejeitado.

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

| Argumento / Opção | Descrição |
| - | - |
| `<id>` | ID da chave de API **(obrigatório)** |
| `-y, --yes` | Ignora a confirmação |

```bash Exemplos theme={null}
# Interativo (pede confirmação)
so-me settings:revoke-api-key 550e8400-e29b-41d4-a716-446655440000

# Não interativo (para scripts)
so-me settings:revoke-api-key 550e8400-e29b-41d4-a716-446655440000 --yes

# Encontrar uma chave pelo nome e depois revogá-la
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.