Saltar al contenido principal

Documentation Index

Fetch the complete documentation index at: https://docs.mka1.com/llms.txt

Use this file to discover all available pages before exploring further.

Utiliza tu clave API de MKA1 en el encabezado Authorization en cada solicitud. Para integraciones de servidor multiusuario, también envía X-On-Behalf-Of para identificar al usuario final.
¿Necesitas la ruta completa de la solicitud, reglas de propagación de encabezados y detalles internos del intercambio de JWT? Lee la explicación detallada de autenticación.

Envía tu clave API

Pasa tu clave API como un token bearer.
Authorization: Bearer <mka1-api-key>
Utiliza https://apigw.mka1.com como la URL base.
export MKA1_BEARER_AUTH='Bearer <mka1-api-key>'

mka1 whoami -H 'X-On-Behalf-Of: <end-user-id>'
Si tu clave API falta, es inválida o no tiene acceso al recurso solicitado, la API de MKA1 devolverá un error de autenticación o autorización.

Envía X-On-Behalf-Of para un usuario final

Utiliza X-On-Behalf-Of cuando tu servidor realice una solicitud en nombre de uno de tus usuarios finales. Establece el valor del encabezado como tu propio identificador estable de usuario final.
X-On-Behalf-Of: <end-user-id>
Por ejemplo, si tu aplicación almacena usuarios como user_123, utiliza ese valor de manera consistente en las solicitudes realizadas para ese usuario.
mka1 whoami -H 'X-On-Behalf-Of: user_123'
Si tu integración no actúa para un usuario final específico, omite X-On-Behalf-Of.

Elige el patrón correcto

Utiliza solo Authorization cuando:
  • Estás llamando a la API de MKA1 para tu propio flujo de trabajo backend.
  • La solicitud no está asociada a un usuario final específico.
Utiliza tanto Authorization como X-On-Behalf-Of cuando:
  • Tu servidor actúa en nombre de uno de tus usuarios finales.
  • Quieres que las solicitudes, respuestas, archivos o el uso permanezcan asociados a ese usuario final.
No envíes una dirección de correo electrónico o un nombre visible mutable a menos que ya sea tu identificador estable de usuario final. Utiliza un ID de tu propio sistema que no cambie.

Intercambia una clave API por un JWT

Utiliza POST /api/v1/authentication/api-key/exchange-token cuando necesites un JWT de corta duración para un servicio downstream. Envía tu clave API de MKA1 en Authorization. Luego, pasa un cuerpo JSON con:
  • audience: La URL del servicio que debe aceptar el token.
  • externalUserId: Tu ID de usuario final para el sujeto del JWT.
  • expiresIn: Duración opcional del token en segundos. La especificación OpenAPI permite de 300 a 2592000.
mka1 auth api-key get-jwt-from-key \
  --audience https://my-awesome-website.com \
  --external-user-id user_123 \
  --expires-in 3600
Una respuesta exitosa devuelve un objeto JSON con token.

Usa un JWT para solicitudes posteriores

Una vez que tengas un JWT del endpoint de intercambio, utilízalo como token bearer en lugar de tu clave API. Esto te permite emitir credenciales de corta duración a servicios downstream o usuarios finales sin exponer tu clave API.
# Pasa el JWT explícitamente vía -H para sobrescribir MKA1_BEARER_AUTH
mka1 llm responses create \
  --model meetkai:functionary-es-mini \
  --input '"Write a short welcome message."' \
  -H 'Authorization: Bearer <jwt-token>'

Próximos pasos