Link to this sectionChaves de API#

As chaves de API da Ultralytics Platform permitem acesso programático seguro para treinamento remoto, inferência e automação. Crie chaves nomeadas com criptografia AES-256-GCM para diferentes casos de uso.

Link to this sectionCriar Chave de API#

Crie uma nova chave de API:

1. Vá para Settings > API Keys
2. Clique em Create Key
3. Insira um nome para a chave (por exemplo, "Servidor de Treinamento")
4. Clique em Create Key

Link to this sectionNome da Chave#

Dê à sua chave um nome descritivo:

• training-server - Para máquinas de treinamento remoto
• ci-pipeline - Para integração CI/CD
• local-dev - Para desenvolvimento local

Link to this sectionExibição da Chave#

Após a criação, a chave é exibida uma vez:

Link to this sectionFormato da Chave#

As chaves de API seguem este formato:

• Prefixo: ul_ identifica chaves da Ultralytics
• Corpo: 40 caracteres hexadecimais aleatórios
• Total: 43 caracteres

Link to this sectionSegurança da Chave#

• As chaves são armazenadas com criptografia AES-256-GCM
• A autenticação usa um hash SHA-256 para uma pesquisa indexada rápida
• Valores de chave completos nunca são armazenados em texto simples

Link to this sectionUsando Chaves de API#

Link to this sectionVariável de ambiente#

Defina sua chave como uma variável de ambiente:

export ULTRALYTICS_API_KEY="YOUR_API_KEY"

Link to this sectionYOLO CLI#

Defina a chave usando a YOLO CLI:

yolo settings api_key="YOUR_API_KEY"

Link to this sectionNo código#

Use a chave em seus scripts Python:

import os

# From environment (recommended)
api_key = os.environ.get("ULTRALYTICS_API_KEY")

# Or directly (not recommended for production)
api_key = "YOUR_API_KEY"

Link to this sectionCabeçalhos HTTP#

Inclua a chave em solicitações de API:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://platform.ultralytics.com/api/...

Veja a Referência da REST API para todos os endpoints disponíveis.

Link to this sectionTreinamento Remoto#

Habilite o streaming de métricas com sua chave.

pip install "ultralytics>=8.4.60"

export ULTRALYTICS_API_KEY="YOUR_API_KEY"
yolo train model=yolo26n.pt data=coco.yaml project=username/project name=exp1

Veja Treinamento na Nuvem para o guia completo de treinamento remoto.

Link to this sectionGerenciar Chaves#

Link to this sectionVer Chaves#

Todas as chaves estão listadas na aba Settings > API Keys:

Cada cartão de chave mostra o nome da chave, o valor da chave descriptografado completo (copiável), o tempo relativo de criação e um botão de revogação.

Link to this sectionRevogar Chave#

Revogue uma chave que esteja comprometida ou que não seja mais necessária:

1. Encontre a chave na seção API Keys
2. Clique no botão Revoke (lixeira)
3. Confirme a revogação

Link to this sectionRegenerar Chave#

Se uma chave estiver comprometida:

1. Crie uma nova chave com o mesmo nome
2. Atualize suas aplicações
3. Revogue a chave antiga

Link to this sectionChaves de API do Workspace#

As chaves de API estão vinculadas ao workspace atualmente ativo:

• Workspace pessoal: As chaves autenticam como sua conta pessoal
• Workspace de equipe: As chaves autenticam dentro do contexto da equipe

Ao alternar workspaces na barra lateral, a seção API Keys mostra as chaves para aquele workspace. A função de Editor ou superior é necessária para gerenciar chaves de API do workspace. Veja Equipes para detalhes sobre as funções.

Link to this sectionMelhores Práticas de Segurança#

Link to this sectionFaça#

• Armazene chaves em variáveis de ambiente
• Use chaves separadas para diferentes ambientes
• Revogue chaves não utilizadas prontamente
• Rotacione as chaves periodicamente
• Use nomes descritivos para identificar os propósitos das chaves

Link to this sectionNão faça#

• Confirmar chaves no controle de versão
• Compartilhar chaves entre aplicações
• Registrar chaves na saída da aplicação
• Embutir chaves no código do lado do cliente

Link to this sectionRotação de Chaves#

Rotacione as chaves periodicamente por segurança:

1. Crie uma nova chave com o mesmo nome
2. Atualize as aplicações para usar a nova chave
3. Verifique se as aplicações funcionam corretamente
4. Revogue a chave antiga

Link to this sectionSolução de Problemas#

Link to this sectionErro de Chave Inválida#

Soluções:

1. Verifique se a chave foi copiada corretamente (incluindo o prefixo ul_)
2. Verifique se a chave não foi revogada
3. Confirme se a variável de ambiente está definida
4. Certifique-se de que você está usando ultralytics>=8.4.60

Link to this sectionPermissão Negada#

Soluções:

1. Verifique se você é o proprietário do recurso ou se possui acesso apropriado ao workspace
2. Verifique se a chave pertence ao workspace correto
3. Crie uma nova chave, se necessário

Link to this sectionLimite de Taxa (Rate Limited)#

Soluções:

1. Reduza a frequência de solicitações — veja a tabela de limites de taxa para limites por endpoint
2. Implemente recuo exponencial usando o cabeçalho Retry-After
3. Use um endpoint dedicado para throughput de inferência ilimitado

Link to this sectionFAQ#

Link to this sectionQuantas chaves posso criar?#

Não há um limite rígido para chaves de API. Crie quantas forem necessárias para diferentes aplicações e ambientes.

Link to this sectionAs chaves expiram?#

As chaves não expiram automaticamente. Elas permanecem válidas até serem revogadas. Considere implementar a rotação por segurança.

Link to this sectionPosso ver minha chave após a criação?#

Sim, os valores completos das chaves estão visíveis na lista de chaves em Settings > API Keys. A plataforma descriptografa e exibe suas chaves para que você possa copiá-las a qualquer momento.

Link to this sectionAs chaves são específicas da região?#

As chaves funcionam em todas as regiões, mas acessam apenas os dados na região da sua conta.

Link to this sectionPosso compartilhar chaves com membros da equipe?#

Melhor prática: peça para cada membro da equipe criar sua própria chave. Para espaços de trabalho de equipe, cada membro com a função de Editor ou superior pode criar chaves restritas a esse espaço de trabalho.