Endpoints disponibles
En esta página
Visión general de la API de Grok
La API de xAI no se limita a la generación de texto. Expone un conjunto de endpoints que abarcan la generación de imágenes y vídeo, la síntesis de voz, la gestión de archivos y el procesamiento asíncrono. Esta lección detalla los endpoints disponibles para que sepas qué funciones utilizar en tus proyectos.
Generación de texto
POST /v1/responses (recomendado)
El endpoint principal para cualquier interacción con los modelos de Grok. Admite texto, visión, herramientas (llamadas a funciones), búsqueda web y búsqueda en X.
Parámetros clave: model, input, instructions, stream, tools, reasoning.
POST /v1/chat/completions (compatible con OpenAI)
El endpoint en formato OpenAI, mantenido para garantizar la compatibilidad con herramientas existentes. Acepta los mismos parámetros que la API de OpenAI: model, messages, temperature, stream, tools.
GET /v1/responses/{id}
Recupera una respuesta generada previamente si esta se almacenó (parámetro store: true). Las respuestas se conservan durante 30 días.
DELETE /v1/responses/{id}
Elimina una respuesta almacenada antes de que caduque automáticamente tras 30 días.
Procesamiento asíncrono
POST /v1/chat/completions (modo diferido)
Cuando añades "deferred": true a la solicitud, la API devuelve inmediatamente un request_id sin esperar a que finalice la generación. Resulta útil para solicitudes largas o procesamiento por lotes.
GET /v1/chat/deferred-completion/{request_id}
Recupera el resultado de una llamada asíncrona:
- HTTP 200: la generación ha finalizado y el cuerpo contiene la respuesta completa.
- HTTP 202: la generación sigue en curso; inténtalo de nuevo más tarde.
Generación de imágenes
POST /v1/images/generations
Genera imágenes a partir de una descripción textual.
POST /v1/images/edits
Edita una imagen existente basándose en instrucciones de texto.
Generación de vídeo
POST /v1/videos/generations
Inicia la generación de un vídeo a partir de un prompt de texto.
GET /v1/videos/{id}
Comprueba el estado de un vídeo en proceso de generación y recupera la URL del resultado una vez finalizado.
POST /v1/videos/edits
Edita un vídeo existente.
POST /v1/videos/extensions
Amplía un vídeo existente.
Síntesis de voz
POST /v1/tts
Convierte texto en audio (texto a voz). Útil para crear asistentes de voz o contenido de audio automatizado.
Agente de voz en tiempo real
WSS wss://api.x.ai/v1/realtime
Un endpoint WebSocket para construir agentes de voz interactivos. La comunicación ocurre en tiempo real, enviando y recibiendo audio.
Gestión de archivos
POST /v1/files
Sube un archivo a la plataforma de xAI. Los archivos pueden utilizarse posteriormente para RAG (generación aumentada por recuperación) con colecciones.
GET /v1/files
Enumera todos los archivos subidos a tu espacio.
GET /v1/files/{id}
Recupera los metadatos de un archivo específico.
DELETE /v1/files/{id}
Elimina un archivo subido.
Procesamiento por lotes
POST /v1/batches
Crea un lote de solicitudes para procesarlas como un grupo, a menudo a un precio reducido.
GET /v1/batches
Enumera los lotes en curso y completados.
Herramientas integradas en el servidor
El endpoint /v1/responses admite herramientas que la API ejecuta directamente, sin necesidad de lógica en el lado del cliente:
- web_search: búsqueda web en tiempo real
- x_search: búsqueda en publicaciones de X (Twitter)
- code_interpreter: ejecución de código Python
- function: llamadas a funciones personalizadas (function calling)
Activas estas herramientas mediante el parámetro tools de la solicitud.
Puntos clave
- La API cubre texto, imágenes, vídeo, audio y archivos
/v1/responseses el endpoint principal y ofrece el soporte más completo- El modo
deferredhabilita el procesamiento asíncrono para solicitudes largas - Las herramientas del lado del servidor (web_search, x_search, code_interpreter) enriquecen las respuestas sin código adicional