Skip to main content
As requisições à API Venice são autenticadas com chaves de API do tipo Bearer. Este guia mostra como criar uma chave a partir do painel da Venice, armazená-la com segurança e verificar se ela está funcionando.
Se você está construindo um agente autônomo que precisa criar sua própria chave com uma carteira, use o guia Criação de chave de API por agente autônomo em vez deste.

​
Antes de começar

  • Faça login na sua conta Venice.
  • Certifique-se de que a conta tenha um saldo disponível antes de chamar endpoints pagos. Você pode criar uma chave antes de adicionar fundos à conta, mas as requisições aos modelos não terão sucesso até que a conta possa consumir DIEM, créditos incluídos ou USD.
1

Abra as configurações da API

Acesse https://venice.ai/settings/api. Você também pode abrir essa página pelo app da Venice selecionando API nas configurações.O painel de configurações da API mostra seus saldos, o seu tier de API, o uso e as chaves de API existentes.
2

Inicie uma nova chave

Selecione Generate New API Key (Gerar nova chave de API) e configure a chave:
  • Description: Use um nome curto que identifique o aplicativo, o ambiente ou a integração que usará essa chave.
  • API Key Type: Use Inference Only para requisições normais aos modelos. Use Admin apenas quando a chave precisar gerenciar chaves de API de forma programática.
  • Expires at: Opcionalmente, defina uma data de expiração. Se você deixar em branco, a chave não expira automaticamente.
  • Epoch Consumption Limits: Opcionalmente, limite quanto de DIEM ou USD essa chave pode gastar durante uma época de 24 horas. Se você deixar em branco, a chave poderá usar o saldo disponível da conta, sujeito aos limites da sua conta.
3

Gere e copie a chave

Clique em Generate. A Venice exibirá a chave de API completa uma única vez.
Copie a chave imediatamente e armazene-a em um local seguro. Depois que você fechar a caixa de diálogo, a Venice mostrará apenas metadados de identificação, como a descrição da chave e os últimos caracteres. Se você perder o valor secreto, exclua a chave e crie uma nova.
Adicione a chave ao seu ambiente local ou gerenciador de segredos:
4

Verifique a chave

Faça uma requisição de baixo risco para confirmar que a autenticação está funcionando:
Uma resposta bem-sucedida retorna os modelos disponíveis. Se você receber um erro de autenticação, confirme se a chave foi copiada por completo e se o cabeçalho Authorization está formatado como Bearer <api-key>.
Desativar os gastos em USD durante a criação da chave de API no aplicativo Venice define o seu limite de gasto em USD como zero para essa chave de API. As chamadas de API podem falhar com um erro de saldo insuficiente quando o seu DIEM disponível ou os créditos agrupados não conseguirem cobrir a solicitação, mesmo que sua conta tenha saldo em USD.

​
Solução de problemas com erros de limite de gasto

Os limites de gasto por chave são independentes do saldo da sua conta. Uma chave pode ficar impedida de gastar mesmo quando a sua conta ainda tem créditos em USD, DIEM ou créditos incluídos disponíveis. Se uma requisição retornar um 402 com um destes códigos, a causa é o próprio limite da chave e não o saldo da conta:
  • API_KEY_USD_SPEND_LIMIT_EXCEEDED — o limite de gasto em USD da chave está definido como zero (o gasto em USD foi desativado na criação) ou a época atual atingiu o seu teto em USD.
  • API_KEY_DIEM_SPEND_LIMIT_EXCEEDED — a chave atingiu o seu teto de DIEM para a época atual de 24 horas.
Para confirmar o estado atual de uma chave, chame Get API Key Rate Limits and Balances e inspecione data.accessPermitted, data.balances e os limites de consumo por chave. Para resolver o erro, aumente ou remova os Epoch Consumption Limits da chave em venice.ai/settings/api, ou chame Update API Key com novos consumptionLimits. Os saldos da conta (USD, DIEM e créditos incluídos) são fontes de pagamento independentes e são consumidos automaticamente conforme a disponibilidade; você não precisa escolher uma delas no momento da requisição. Consulte Códigos de erro para a lista completa de respostas relacionadas a cobrança.

​
Boas práticas

  • Crie chaves separadas para desenvolvimento, staging e produção.
  • Prefira chaves Inference Only para aplicações que apenas chamam endpoints de modelos.
  • Mantenha chaves Admin raras, com escopo restrito e armazenadas apenas em ambientes confiáveis do lado do servidor.
  • Nunca faça commit de chaves de API no controle de versão nem as exponha em código do lado do cliente.
  • Defina datas de expiração e limites de consumo para chaves usadas em ambientes temporários, compartilhados ou de maior risco.
  • Exclua chaves não utilizadas e faça a rotação de qualquer chave que possa ter sido exposta.

​
Gerenciamento programático de chaves

Chaves Admin podem gerenciar chaves de API por meio dos endpoints da referência da API:

Criar chave de API

Crie uma nova chave de API no estilo do painel a partir de uma chave admin existente.

Listar chaves de API

Visualize as chaves ativas e seus metadados.

Atualizar chave de API

Atualize a descrição, a data de expiração ou os limites de consumo de uma chave.

Excluir chave de API

Revogue uma chave que não é mais necessária.