A variável de ambiente XAI_API_KEY
Nesta página
Armazene a sua chave em segurança
Uma chave de API nunca deve aparecer em texto simples no seu código-fonte. A abordagem padrão consiste em armazená-la numa variável de ambiente que a sua aplicação lê durante o arranque. Isto separa a configuração do código e protege os seus segredos.
Definir a XAI_API_KEY
A convenção utilizada pela xAI e por todos os SDKs oficiais é a variável XAI_API_KEY. Eis como defini-la no seu sistema.
Linux e macOS
No seu terminal, adicione a variável ao perfil da sua shell:
echo 'export XAI_API_KEY="xai-your-key-here"' >> ~/.bashrc
source ~/.bashrc
Para o Zsh (o padrão no macOS), substitua .bashrc por .zshrc.
Windows (PowerShell)
$env:XAI_API_KEY = "xai-your-key-here"
Para tornar a alteração permanente, utilize as variáveis de ambiente do sistema através das definições avançadas ou execute:
[System.Environment]::SetEnvironmentVariable("XAI_API_KEY", "xai-your-key-here", "User")
Ficheiro .env (projetos locais)
Para projetos que utilizam uma framework (Node.js, Django, Flask), crie um ficheiro .env na raiz:
XAI_API_KEY=xai-your-key-here
Deve adicionar .env ao seu ficheiro .gitignore para não enviar os seus segredos para um repositório Git:
# .gitignore
.env
.env.local
.env.*.local
Verificar a configuração
Teste se a variável está disponível:
echo $XAI_API_KEY
Deverá ver a sua chave. Se o comando devolver uma linha vazia, recarregue o perfil da sua shell ou reinicie o terminal.
Em Python, pode verificá-la da seguinte forma:
import os
key = os.getenv("XAI_API_KEY")
print("Key configured" if key else "Variable missing")
Ambientes de produção
Em produção, não utilize um ficheiro .env. Utilize antes os mecanismos integrados da sua plataforma:
- Docker:
docker run -e XAI_API_KEY=xai-xxx my-image - Kubernetes: um Secret montado como variável de ambiente
- Vercel / Netlify / Railway: variáveis no painel do projeto
- GitHub Actions: segredos do repositório (
${{ secrets.XAI_API_KEY }})
Estes sistemas encriptam os segredos em repouso e injetam-nos apenas em tempo de execução.
Erros comuns
- Aspas extra na chave: se a sua variável contiver aspas literais, os pedidos falharão com um erro de autenticação
- Variável definida noutra shell: as variáveis de um terminal não estão disponíveis noutro, a menos que sejam exportadas no seu perfil
- Espaços em torno do sinal
=: num ficheiro.env, a sintaxeXAI_API_KEY = valuecom espaços pode falhar, dependendo da biblioteca que utilizar
Pontos-chave
- Utilize a variável
XAI_API_KEY, reconhecida por todos os SDKs da xAI - Nunca inclua a chave diretamente no seu código-fonte
- Adicione
.envao.gitignorede todos os seus projetos - Em produção, utilize os segredos integrados da sua plataforma de alojamento