- Autenticar requisições para a Novita AI com uma chave de API Bearer.
- Criar uma chave de API no console e armazená-la com segurança.
- Definir a chave como uma variável de ambiente no Linux, macOS ou Windows.
- Verificar por quanto tempo uma chave permanece válida e quais operações de chave a OpenAPI oferece suporte.
- Configurar políticas de acesso a modelos e à rede para uma chave.
Autenticação
A Novita AI usa autenticação Bearer para acesso à API. Envie sua chave de API no cabeçalhoAuthorization da requisição:
Criar uma chave de API
1
Abrir Gerenciamento de Chaves
Acesse Gerenciamento de Chaves no console.
2
Criar uma nova chave
Selecione Criar chave de API e dê à chave um nome que reflita sua finalidade, como
production ou local-testing.3
Copiar e armazenar a chave
A chave completa é exibida apenas uma vez, quando é criada. Copie-a imediatamente e armazene-a em um local seguro, como um gerenciador de segredos ou uma variável de ambiente. Se você perdê-la, não poderá recuperá-la; crie uma nova chave.
Configurar controles de acesso
Os controles de acesso são opcionais e configurados por chave de API:- Acesso a modelos para chaves de API controla quais modelos uma chave pode chamar dentro do intervalo de modelos habilitados da sua equipe.
- Acesso de rede para chaves de API controla quais IPs de origem podem usar uma chave para invocação de modelos.
Formato e validade da chave
- Toda chave começa com o prefixo
sk_. - Uma chave é exibida por completo apenas uma vez, quando é criada. Depois disso, o console exibe uma forma mascarada.
- Cada conta pode criar até 10 chaves de API.
Você define a expiração ao criar a chave. Ela não pode ser alterada depois: você não pode renovar uma chave nem expirá-la imediatamente. Chaves Permanentes permanecem válidas indefinidamente, então uma chave vazada permanece utilizável por mais tempo. Use chaves permanentes apenas quando for apropriado. A expiração é configurada apenas no console; a OpenAPI não cria chaves nem define, altera ou remove sua expiração.
O que a OpenAPI abrange
Você cria e exclui chaves de API apenas no console. A OpenAPI da Novita não tem endpoints para criar ou excluir chaves, e não oferece suporte à configuração da expiração de uma chave. Os endpoints da OpenAPI relacionados a chaves permitem listar chaves e gerenciar suas políticas de acesso a modelos e à rede:- Listar chaves de API — lista as chaves da sua equipe, com um resumo opcional de acesso a modelos.
- Obter política de acesso a modelos de chave de API — lê a política de acesso a modelos de uma única chave.
- Definir política de acesso a modelos de chave de API — define ou atualiza a política de acesso a modelos de uma chave.
- Redefinir política de acesso a modelos de chave de API — redefine a política de acesso a modelos de uma chave para o padrão. Isso redefine apenas a política; não exclui a própria chave.
- Obter política de acesso de IP de chave de API — lê a política de acesso de rede de uma única chave.
- Definir política de acesso de IP de chave de API — define ou atualiza os IPs de origem permitidos para uma chave.
- Excluir política de acesso de IP de chave de API — limpa a política de acesso de rede de uma chave, restaurando a ausência de restrição de IP de origem.
Armazene sua chave como uma variável de ambiente
Codificar uma chave diretamente no código-fonte pode expô-la, por exemplo, quando você faz commit do arquivo. Lê-la de uma variável de ambiente comoNOVITA_API_KEY mantém a chave fora do seu código-fonte.
Temporária vs. permanente
Uma chave definida comexport (Linux/macOS) ou set (Windows) dura apenas para a sessão atual do terminal e desaparece quando você a fecha. Isso é adequado para um teste rápido. Para manter a chave entre sessões, defina-a permanentemente como mostrado abaixo e depois abra um novo terminal para que a alteração tenha efeito.
A variável está definida, mas o código ainda não a encontra
Você a definiu temporariamente e abriu um novo terminal
Você a definiu temporariamente e abriu um novo terminal
Uma chave definida com
export ou $env: existe apenas na sessão do terminal em que você executou o comando. Um novo terminal ou aba não a herda. Defina a chave permanentemente (>> ~/.zshrc, setx) ou execute o comando export/$env: novamente na sessão que você está usando.Você a definiu permanentemente, mas não reiniciou
Você a definiu permanentemente, mas não reiniciou
Uma alteração permanente (um perfil de shell ou
setx) se aplica a terminais iniciados após a alteração. Abra um novo terminal e reinicie sua IDE ou editor para que ele possa ler o ambiente atualizado. No Windows, setx não afeta terminais que já estão abertos.Um gerenciador de serviços não herda o ambiente do seu shell
Um gerenciador de serviços não herda o ambiente do seu shell
Processos iniciados por
systemd, supervisor, Docker ou um executor de CI não leem seu perfil de shell interativo. Defina a variável na configuração do próprio serviço, como o Environment= de uma unidade systemd, uma flag docker run -e ou os segredos do projeto de CI, em vez de em ~/.bashrc.Você executou o comando com sudo
Você executou o comando com sudo
sudo não repassa seu ambiente por padrão, então uma variável exportada pelo seu usuário não fica visível para o processo elevado. Use sudo -E para preservar o ambiente ou defina a variável no contexto elevado.Relacionados
- Códigos de erro comuns — resolva respostas
401e403relacionadas a chaves. - Limites de taxa — limites de requisições e tokens que se aplicam à sua conta.