Endpoints disponibles

Vue d’ensemble de l’API Grok

L’API xAI ne se limite pas à la génération de texte. Elle expose un ensemble d’endpoints couvrant la génération d’images, de vidéos, la synthèse vocale, la gestion de fichiers et le traitement asynchrone. Cette leçon cartographie les endpoints disponibles pour que vous sachiez quelles fonctionnalités exploiter dans vos projets.

Génération de texte

POST /v1/responses (recommandé)

L’endpoint principal pour toute interaction avec les modèles Grok. Il supporte le texte, la vision, les outils (function calling), la recherche web et la recherche X.

Paramètres clés : model, input, instructions, stream, tools, reasoning.

POST /v1/chat/completions (compatible OpenAI)

L’endpoint au format OpenAI, maintenu pour la compatibilité avec les outils existants. Il accepte les mêmes paramètres que l’API OpenAI : model, messages, temperature, stream, tools.

GET /v1/responses/{id}

Récupère une réponse précédemment générée si elle a été stockée (paramètre store: true). Les réponses sont conservées pendant 30 jours.

DELETE /v1/responses/{id}

Supprime une réponse stockée avant l’expiration automatique de 30 jours.

Traitement asynchrone

POST /v1/chat/completions (mode deferred)

En ajoutant "deferred": true à la requête, l’API retourne immédiatement un request_id sans attendre la fin de la génération. C’est utile pour les requêtes longues ou les traitements batch.

GET /v1/chat/deferred-completion/{request_id}

Récupère le résultat d’un appel asynchrone :

• HTTP 200 : la génération est terminée, le corps contient la réponse complète
• HTTP 202 : la génération est encore en cours, réessayez plus tard

Génération d’images

POST /v1/images/generations

Génère des images à partir d’une description textuelle.

POST /v1/images/edits

Modifie une image existante selon des instructions textuelles.

Génération de vidéos

POST /v1/videos/generations

Lance la génération d’une vidéo à partir d’un prompt textuel.

GET /v1/videos/{id}

Vérifie le statut d’une vidéo en cours de génération et récupère l’URL du résultat une fois terminé.

POST /v1/videos/edits

Édite une vidéo existante.

POST /v1/videos/extensions

Prolonge une vidéo existante.

Synthèse vocale

POST /v1/tts

Convertit du texte en audio (text-to-speech). Utile pour créer des assistants vocaux ou des contenus audio automatisés.

Agent vocal en temps réel

WSS wss://api.x.ai/v1/realtime

Un endpoint WebSocket pour créer des agents vocaux interactifs. La communication se fait en temps réel avec envoi et réception audio.

Gestion de fichiers

POST /v1/files

Uploade un fichier vers la plateforme xAI. Les fichiers peuvent ensuite être utilisés pour le RAG (Retrieval-Augmented Generation) avec des collections.

GET /v1/files

Liste tous les fichiers uploadés dans votre espace.

GET /v1/files/{id}

Récupère les métadonnées d’un fichier spécifique.

DELETE /v1/files/{id}

Supprime un fichier uploadé.

Traitement par lots (Batch)

POST /v1/batches

Crée un lot de requêtes à traiter de manière groupée, souvent à un tarif réduit.

GET /v1/batches

Liste les lots en cours et terminés.

Outils intégrés côté serveur

L’endpoint /v1/responses supporte des outils exécutés directement par l’API, sans logique côté client :

• web_search : recherche web en temps réel
• x_search : recherche dans les publications X (Twitter)
• code_interpreter : exécution de code Python
• function : appel de fonctions personnalisées (function calling)

Ces outils sont activés via le paramètre tools de la requête.

Points clés à retenir

• L’API couvre le texte, les images, les vidéos, l’audio et les fichiers
• /v1/responses est l’endpoint principal avec le support le plus complet
• Le mode deferred permet le traitement asynchrone pour les requêtes longues
• Les outils côté serveur (web_search, x_search, code_interpreter) enrichissent les réponses sans code supplémentaire