- Autenticar solicitações à Novita AI com uma chave de API Bearer.
- Criar uma chave de API no console e armazená-la com segurança.
- Configurar sua chave como uma variável de ambiente no Linux, macOS e Windows.
- Entender por quanto tempo uma chave permanece válida e o que a OpenAPI cobre e não cobre.
Autenticação
A Novita AI autentica o acesso à API usando autenticação Bearer. Envie sua chave de API noAuthorization cabeçalho da requisição:
Crie uma chave de API
1
Abra o 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 seu propósito, como
production ou local-testing.3
Copie e armazene a chave
A chave completa é mostrada apenas uma vez, na criação. 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.
Opcionalmente, você pode limitar quais modelos uma chave tem permissão para chamar. Consulte Acesso a modelos para chaves de API.
Formato e validade da chave
- Toda chave começa com o
sk_prefixo. - Uma chave é mostrada por completo apenas uma vez, na criação. Depois disso, o console exibe uma forma mascarada.
- Uma chave permanece válida indefinidamente após ser criada. Ela continua funcionando até você excluí-la no console.
- Cada conta pode criar até 10 chaves de API.
O que a OpenAPI cobre
Você cria e exclui chaves de API apenas no console. A Novita OpenAPI não inclui endpoints para criar ou excluir chaves. Os endpoints da OpenAPI relacionados a chaves cobrem a listagem de chaves e o gerenciamento da política de acesso a modelos de uma chave:- Listar chaves de API — liste as chaves na sua equipe, com um resumo opcional de acesso a modelos.
- Obter política de acesso a modelos da chave de API — ler a política de acesso a modelos de uma única chave.
- Definir política de acesso a modelos da chave de API — defina ou atualize a política de acesso a modelos de uma chave.
- Redefinir Política de Acesso a Modelos da 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 chave em si.
Armazene sua chave como uma variável de ambiente
Inserir uma chave diretamente no código-fonte traz o risco de vazá-la, por exemplo, quando você faz commit do arquivo. Ler a chave de uma variável de ambiente, comoNOVITA_API_KEY mantém isso fora do seu código.
Temporário vs. permanente
Um conjunto de chaves comexport (Linux/macOS) ou set (Windows) dura apenas pela sessão atual do terminal e desaparece quando você a fecha. Isso é suficiente para um teste rápido. Para manter a chave entre sessões, defina-a permanentemente conforme mostrado abaixo e, em seguida, abra um novo terminal para que a alteração entre em vigor.
A variável está definida, mas o código ainda não consegue encontrá-la
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: fica disponível apenas na sessão de terminal em que você a executou. Um novo terminal, ou uma nova aba, não a herda. Defina a chave permanentemente (>> ~/.zshrc, setx), ou execute novamente o export/$env: linha na sessão que você está usando.Você definiu isso permanentemente, mas não reiniciou
Você definiu isso permanentemente, mas não reiniciou
Uma alteração permanente (perfil do shell,
setx) se aplica a terminais iniciados após a alteração. Abra um novo terminal e reinicie sua IDE ou editor para que ele detecte o novo ambiente. 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 o perfil do seu shell interativo. Defina a variável na configuração do próprio serviço (por exemplo, uma systemd da unidade Environment=, um docker run -e flag, ou os segredos do projeto de CI), não 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 a variável que você exportou como seu usuário não fica visível para o processo elevado. Use sudo -E para preservar o ambiente, ou defina a variável dentro do contexto elevado.Relacionados
- Acesso a modelos para chaves de API — restrinja quais modelos uma chave pode chamar.
- Códigos de Erro Comuns — resolver
401e403respostas relacionadas a chaves. - Limites de taxa — limites de solicitações e de tokens que se aplicam à sua conta.