xAI API

¿Qué es la xAI API?

La xAI API es una interfaz para desarrolladores que permite usar los modelos Grok de xAI desde el código de tu aplicación. El propósito principal de la API es recibir prompts (y, para algunos modelos, imágenes) y devolver respuestas generadas que puedes mostrar, procesar o estructurar para usos posteriores.

La guía de inicio rápido recorre el flujo completo: crea una cuenta de xAI y añade créditos, genera una clave API, instala un SDK y envía tu primera solicitud a un modelo Grok usando endpoints y ejemplos compatibles.

Características principales

• Autenticación con clave API mediante variable de entorno: Configura tu código con XAI_API_KEY, que los SDK de xAI leen automáticamente.
• Soporte de SDK para lenguajes comunes: Instala el SDK de xAI para Python o JavaScript para llamar a los modelos Grok sin escribir solicitudes HTTP crudas.
• Generación de texto estilo chat: Envía mensajes de sistema y usuario, y muestrea la salida del modelo para respuestas de texto.
• Compatibilidad con endpoint de responses: Llama directamente a https://api.x.ai/v1/responses con una clave API para inferencia de modelos.
• Entradas multimodales (texto + imagen): Para modelos que lo admiten, incluye una URL de imagen junto con texto en una sola solicitud.
• Salidas estructuradas (para modelos compatibles): Algunos modelos permiten imponer un esquema de salida para controlar la forma de los resultados generados.

Cómo usar la xAI API

1. Crea una cuenta de xAI en accounts.x.ai y añade créditos para poder usar la API.
2. Crea una clave API en la Consola de xAI, en API Keys.
3. Configura XAI_API_KEY exportándola en tu terminal o añadiéndola a un archivo .env:
   • export XAI_API_KEY="your_api_key"
   • XAI_API_KEY=your_api_key
4. Instala un SDK según tu lenguaje:
   • Python: pip install xai-sdk
   • JavaScript: npm install ai @ai-sdk/xai zod
5. Envía una solicitud a un modelo Grok (el ejemplo muestra grok-4.20-reasoning para texto, y grok-4 para imagen+texto). Usa los ejemplos del SDK o la solicitud HTTP directa a responses.

Casos de uso

• Construye una interfaz de chat para Grok: Crea una aplicación que envíe preguntas de usuario e instrucciones de sistema opcionales, luego muestre response.content o completion.output_text.
• Genera texto con un endpoint de modelo conocido: Usa el flujo POST https://api.x.ai/v1/responses para integrar Grok en servicios donde prefieras llamadas HTTP directas.
• Añade comprensión de imágenes a un flujo de P&R: Envía una URL de imagen con un prompt como “¿Qué hay en esta imagen?” usando el formato de solicitud multimodal de la guía de inicio rápido.
• Impón formato de salida para procesamiento posterior: Al usar un modelo Grok compatible, aplica Salidas Estructuradas para que los resultados sigan un esquema que definas.
• Ejecuta experimentos rápidos en diferentes entornos: Cambia entre ejemplos de Python y JavaScript manteniendo la misma configuración de variable de entorno (XAI_API_KEY).

Preguntas frecuentes

¿Cómo autentico solicitudes a la xAI API?

Crea una clave API en la Consola de xAI y configúrala como XAI_API_KEY (por ejemplo, con export XAI_API_KEY="..." o un archivo .env). El SDK de xAI está configurado para leer esta variable de entorno automáticamente.

¿Qué modelo Grok puedo usar para mi primera solicitud?

Los ejemplos de la guía de inicio rápido usan grok-4.20-reasoning para generación de texto estilo chat y grok-4 para entradas de imagen+texto.

¿Puedo llamar a la API sin un SDK?

Sí. La guía de inicio rápido incluye un ejemplo directo con curl que hace POST a https://api.x.ai/v1/responses con un cuerpo JSON que contiene model e input.

¿Cómo envío imágenes a Grok?

Para modelos que aceptan imágenes, incluye una URL de imagen en la entrada junto con texto (el ejemplo usa una estructura input_image / input_text en el SDK o una estructura de contenido tipada en la llamada a responses).

¿Qué son las Salidas Estructuradas?

La guía de inicio rápido indica que ciertos modelos admiten Salidas Estructuradas, que te permiten imponer un esquema para la salida del LLM. La página remite a una “Guía de Generación de Texto” dedicada para un uso más profundo.

Alternativas

• Usa la API de chat/asistentes de otro proveedor de LLM: Si tu flujo es “prompt de entrada, texto generado de salida”, puedes cambiar por la API de otro proveedor usando autenticación basada en claves y formato de solicitud similar.
• Usa un enfoque de generación de texto agnóstico a frameworks: En lugar de un SDK específico de proveedor, construye solicitudes directamente contra un endpoint estilo “completions/responses” para mantener la integración consistente entre lenguajes.
• Usa APIs de modelos multimodales: Si tu necesidad principal es comprensión de imagen+texto, busca proveedores que admitan explícitamente entradas de imagen en su esquema de solicitud API, y adapta el payload en consecuencia.