Link to this sectionClaves de API#

Las claves de API de la Plataforma Ultralytics permiten un acceso programático seguro para entrenamiento remoto, inferencia y automatización. Crea claves con nombre mediante cifrado AES-256-GCM para diferentes casos de uso.

Link to this sectionCrear clave de API#

Crea una nueva clave de API:

1. Ve a Configuración > Claves de API
2. Haz clic en Crear clave
3. Introduce un nombre para la clave (por ejemplo, "Servidor de entrenamiento")
4. Haz clic en Crear clave

Link to this sectionNombre de la clave#

Dale a tu clave un nombre descriptivo:

• training-server - Para máquinas de entrenamiento remoto
• ci-pipeline - Para integración CI/CD
• local-dev - Para desarrollo local

Link to this sectionVisualización de la clave#

Tras su creación, la clave se muestra una vez:

Link to this sectionFormato de clave#

Las claves de API siguen este formato:

• Prefijo: ul_ identifica las claves de Ultralytics
• Cuerpo: 40 caracteres hexadecimales aleatorios
• Total: 43 caracteres

Link to this sectionSeguridad de las claves#

• Las claves se almacenan con cifrado AES-256-GCM
• La autenticación utiliza el hash SHA-256 para una búsqueda rápida del prefijo y la comparación de hashes
• Los valores completos de las claves nunca se almacenan en texto plano

Link to this sectionUso de claves de API#

Link to this sectionVariable de entorno#

Establece tu clave como variable de entorno:

export ULTRALYTICS_API_KEY="YOUR_API_KEY"

Link to this sectionYOLO CLI#

Establece la clave usando la YOLO CLI:

yolo settings api_key="YOUR_API_KEY"

Link to this sectionEn el código#

Utiliza la clave en tus scripts de 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 sectionCabeceras HTTP#

Incluye la clave en las peticiones de API:

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

Consulta la Referencia de la REST API para ver todos los puntos de acceso disponibles.

Link to this sectionEntrenamiento remoto#

Activa el streaming de métricas con tu clave.

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

Consulta Entrenamiento en la nube para obtener la guía completa de entrenamiento remoto.

Link to this sectionGestionar claves#

Link to this sectionVer claves#

All keys are listed on the Settings > API Keys tab:

Cada tarjeta de clave muestra el nombre, el valor completo descifrado (copiable), el tiempo de creación relativo y un botón para revocar.

Link to this sectionRevocar clave#

Revoca una clave que esté comprometida o que ya no necesites:

1. Encuentra la clave en la sección de Claves de API
2. Haz clic en el botón Revocar (papelera)
3. Confirma la revocación

Link to this sectionRegenerar clave#

Si una clave está comprometida:

1. Crea una nueva clave con el mismo nombre
2. Actualiza tus aplicaciones
3. Revoca la clave antigua

Link to this sectionClaves de API de espacio de trabajo#

Las claves de API están vinculadas al espacio de trabajo activo:

• Espacio de trabajo personal: Las claves se autentican como tu cuenta personal
• Espacio de trabajo de equipo: Las claves se autentican dentro del contexto del equipo

Al cambiar de espacio de trabajo en la barra lateral, la sección de Claves de API muestra las claves para ese espacio. Se requiere el rol de Editor o superior para gestionar las claves de API del espacio de trabajo. Consulta Equipos para detalles sobre los roles.

Link to this sectionBuenas prácticas de seguridad#

Link to this sectionQué hacer#

• Almacena las claves en variables de entorno
• Usa claves separadas para distintos entornos
• Revoca las claves que no uses de inmediato
• Rota las claves periódicamente
• Usa nombres descriptivos para identificar el propósito de cada clave

Link to this sectionQué no hacer#

• No subas las claves al control de versiones
• No compartas claves entre aplicaciones
• No registres las claves en la salida de las aplicaciones
• No incorpores claves en el código del lado del cliente

Link to this sectionRotación de claves#

Rota las claves periódicamente por seguridad:

1. Crea una nueva clave con el mismo nombre
2. Actualiza las aplicaciones para usar la nueva clave
3. Verifica que las aplicaciones funcionen correctamente
4. Revoca la clave antigua

Link to this sectionResolución de problemas#

Link to this sectionError de clave no válida#

Soluciones:

1. Verifica que la clave se haya copiado correctamente (incluyendo el prefijo ul_)
2. Comprueba que la clave no haya sido revocada
3. Confirma que la variable de entorno esté establecida
4. Asegúrate de estar usando ultralytics>=8.4.60

Link to this sectionPermiso denegado#

Soluciones:

1. Verifica que eres el propietario del recurso o que tienes el acceso adecuado al espacio de trabajo
2. Comprueba que la clave pertenezca al espacio de trabajo correcto
3. Crea una nueva clave si es necesario

Link to this sectionLímite de tasa alcanzado#

Soluciones:

1. Reduce la frecuencia de peticiones; consulta la tabla de límites de tasa para conocer los límites por punto de acceso
2. Implementa un retroceso exponencial usando la cabecera Retry-After
3. Usa un punto de acceso dedicado para un rendimiento de inferencia ilimitado

Link to this sectionPreguntas frecuentes#

Link to this section¿Cuántas claves puedo crear?#

No hay un límite estricto para las claves de API. Crea todas las que necesites para diferentes aplicaciones y entornos.

Link to this section¿Caducan las claves?#

Las claves no caducan automáticamente. Permanecen válidas hasta que se revoquen. Considera implementar una rotación por motivos de seguridad.

Link to this section¿Puedo ver mi clave después de crearla?#

Sí, los valores completos de las claves son visibles en la lista de claves en Settings > API Keys. La Platform descifra y muestra tus claves para que puedas copiarlas en cualquier momento.

Link to this section¿Las claves son específicas de una región?#

Las claves funcionan en todas las regiones, pero solo acceden a los datos de la región de tu cuenta.

Link to this section¿Puedo compartir claves con los miembros del equipo?#

Mejor práctica: haz que cada miembro del equipo cree su propia clave. Para espacios de trabajo de equipo, cada miembro con rol de Editor o superior puede crear claves asignadas a ese espacio de trabajo.