Endpoint disponibili
In questa pagina
Panoramica delle API Grok
Le API xAI non si limitano alla generazione di testo. Espongono una serie di endpoint che coprono la generazione di immagini e video, la sintesi vocale, la gestione dei file e l’elaborazione asincrona. Questa lezione mappa gli endpoint disponibili per aiutarti a scegliere le funzionalità più adatte ai tuoi progetti.
Generazione di testo
POST /v1/responses (consigliato)
L’endpoint principale per qualsiasi interazione con i modelli Grok. Supporta testo, visione, strumenti (chiamate di funzione), ricerca web e ricerca su X.
Parametri chiave: model, input, instructions, stream, tools, reasoning.
POST /v1/chat/completions (compatibile con OpenAI)
L’endpoint nel formato OpenAI, mantenuto per garantire la compatibilità con gli strumenti esistenti. Accetta gli stessi parametri delle API OpenAI: model, messages, temperature, stream, tools.
GET /v1/responses/{id}
Recupera una risposta generata in precedenza se è stata archiviata (parametro store: true). Le risposte vengono conservate per 30 giorni.
DELETE /v1/responses/{id}
Elimina una risposta archiviata prima che scada automaticamente dopo 30 giorni.
Elaborazione asincrona
POST /v1/chat/completions (modalità differita)
Quando aggiungi "deferred": true alla richiesta, l’API restituisce immediatamente un request_id senza attendere il termine della generazione. È utile per richieste lunghe o elaborazioni in batch.
GET /v1/chat/deferred-completion/{request_id}
Recupera il risultato di una chiamata asincrona:
- HTTP 200: la generazione è terminata e il corpo contiene la risposta completa
- HTTP 202: la generazione è ancora in corso, riprova più tardi
Generazione di immagini
POST /v1/images/generations
Genera immagini a partire da una descrizione testuale.
POST /v1/images/edits
Modifica un’immagine esistente sulla base di istruzioni testuali.
Generazione di video
POST /v1/videos/generations
Avvia la generazione di un video da un prompt testuale.
GET /v1/videos/{id}
Controlla lo stato di un video in fase di generazione e recupera l’URL del risultato una volta terminato.
POST /v1/videos/edits
Modifica un video esistente.
POST /v1/videos/extensions
Estende un video esistente.
Sintesi vocale
POST /v1/tts
Converte il testo in audio (text-to-speech). Utile per creare assistenti vocali o contenuti audio automatizzati.
Agente vocale in tempo reale
WSS wss://api.x.ai/v1/realtime
Un endpoint WebSocket per costruire agenti vocali interattivi. La comunicazione avviene in tempo reale, con invio e ricezione di audio.
Gestione dei file
POST /v1/files
Carica un file sulla piattaforma xAI. I file possono poi essere utilizzati per la RAG (generazione aumentata dal recupero) con le collezioni.
GET /v1/files
Elenca tutti i file caricati nel tuo spazio.
GET /v1/files/{id}
Recupera i metadati di un file specifico.
DELETE /v1/files/{id}
Elimina un file caricato.
Elaborazione in batch
POST /v1/batches
Crea un lotto di richieste da elaborare come gruppo, spesso a un prezzo ridotto.
GET /v1/batches
Elenca i batch in corso e quelli completati.
Strumenti integrati lato server
L’endpoint /v1/responses supporta strumenti eseguiti direttamente dall’API, senza logica lato client:
- web_search: ricerca web in tempo reale
- x_search: ricerca nei post di X (Twitter)
- code_interpreter: esecuzione di codice Python
- function: chiamate di funzioni personalizzate (function calling)
Attivi questi strumenti tramite il parametro tools della richiesta.
Punti chiave
- L’API copre testo, immagini, video, audio e file
/v1/responsesè l’endpoint principale, con il supporto più completo- La modalità
deferredabilita l’elaborazione asincrona per richieste lunghe - Gli strumenti lato server (web_search, x_search, code_interpreter) arricchiscono le risposte senza codice aggiuntivo