Gerar uma chave de API
Nesta página
Acesso programático ao Grok
A chave de API é o token de autenticação que permite às suas aplicações comunicar com os modelos Grok. Sem ela, nenhum pedido é processado. Esta lição guia-o na criação e gestão das suas chaves na consola xAI.
Abrir a consola
Aceda a console.x.ai e inicie sessão com a conta que criou no passo anterior. A consola é o seu painel central para gerir chaves, monitorizar a utilização e configurar a faturação.
No menu lateral, abra API Keys (caminho completo: console.x.ai/team/default/api-keys).
Criar a sua primeira chave
Clique em Create API Key. Pode atribuir um nome descritivo a cada chave para identificar a sua finalidade:
dev-localpara o seu ambiente de desenvolvimentoprod-backendpara o seu servidor de produçãotest-cipara o seu pipeline de integração contínua
A chave é apresentada apenas uma vez, no momento da criação. Copie-a imediatamente e guarde-a num local seguro (um gestor de palavras-passe ou um cofre de segredos). Se perder uma chave, terá de gerar uma nova.
Formato da chave
As chaves de API da xAI começam com o prefixo xai- seguido de uma cadeia alfanumérica. Esse prefixo ajuda-o a identificá-las rapidamente nos seus ficheiros de configuração e a detetá-las caso sejam acidentalmente expostas no código-fonte.
Melhores práticas de gestão
Uma chave por ambiente
Crie chaves separadas para cada contexto. Se uma chave for comprometida, pode revogá-la sem afetar os seus outros ambientes.
Rotação regular
Renove as suas chaves periodicamente, especialmente para ambientes de produção. O procedimento é simples: crie uma nova chave, atualize a sua aplicação e, em seguida, elimine a antiga.
Verificar antes de partilhar
Antes de partilhar um projeto, certifique-se de que nenhuma chave está codificada diretamente no código-fonte. Utilize ficheiros .env mantidos fora do controlo de versões (adicione .env ao seu .gitignore).
Faturação associada às chaves
Cada chamada à API feita com uma chave é contabilizada e faturada. A xAI oferece dois modos:
- Créditos pré-pagos: compra créditos antecipadamente e as chamadas são deduzidas imediatamente
- Faturação mensal: a utilização que exceda os seus créditos é faturada no final do mês
Consulte as suas informações de faturação na consola antes de começar a utilizar a API, pois as faturas não podem ser alteradas retroativamente.
Testar a chave imediatamente
Reserve trinta segundos para validar a chave antes de a integrar num projeto. O teste mais simples solicita a lista de modelos:
curl https://api.x.ai/v1/models \
-H "Authorization: Bearer xai-your-key"
Uma resposta JSON que liste os modelos confirma que a chave está ativa e que a faturação está em ordem. Um erro 401 significa que a chave foi copiada incorretamente; um erro 403 indica um problema de permissões ou de créditos. Diagnosticar o problema aqui, na origem, poupa-lhe uma sessão de depuração mais tarde, no meio do código da sua aplicação.
Pontos-chave
- Cria chaves em console.x.ai/team/default/api-keys
- Começam por
xai-e são apresentadas apenas uma vez - Crie uma chave por ambiente e guarde-as num cofre de segredos
- Verifique o seu modo de faturação antes de qualquer chamada à API
- Valide cada nova chave com uma chamada a
/v1/modelsantes de a integrar