Endpointuri disponibile
Pe această pagină
Prezentare generală a API-ului Grok
API-ul xAI nu se limitează la generarea de text. Acesta expune un set de endpointuri care acoperă generarea de imagini și video, sinteza vocală, gestionarea fișierelor și procesarea asincronă. Această lecție cartografiază endpointurile disponibile pentru a ști ce funcționalități să utilizați în proiectele dumneavoastră.
Generarea de text
POST /v1/responses (recomandat)
Endpointul principal pentru orice interacțiune cu modelele Grok. Acesta suportă text, viziune, instrumente (apeluri de funcții), căutare pe web și căutare în X.
Parametri cheie: model, input, instructions, stream, tools, reasoning.
POST /v1/chat/completions (compatibil OpenAI)
Endpointul în format OpenAI, menținut pentru compatibilitatea cu instrumentele existente. Acesta acceptă aceiași parametri ca API-ul OpenAI: model, messages, temperature, stream, tools.
GET /v1/responses/{id}
Recuperează un răspuns generat anterior dacă acesta a fost stocat (parametrul store: true). Răspunsurile sunt păstrate timp de 30 de zile.
DELETE /v1/responses/{id}
Șterge un răspuns stocat înainte ca acesta să expire automat după 30 de zile.
Procesarea asincronă
POST /v1/chat/completions (mod diferat)
Când adăugați "deferred": true la cerere, API-ul returnează imediat un request_id fără a aștepta finalizarea generării. Acest lucru este util pentru cereri lungi sau procesarea în loturi.
GET /v1/chat/deferred-completion/{request_id}
Recuperează rezultatul unui apel asincron:
- HTTP 200: generarea s-a încheiat, iar corpul conține răspunsul complet
- HTTP 202: generarea este încă în curs, așa că încercați din nou mai târziu
Generarea de imagini
POST /v1/images/generations
Generează imagini pe baza unei descrieri textuale.
POST /v1/images/edits
Editează o imagine existentă pe baza unor instrucțiuni text.
Generarea de video
POST /v1/videos/generations
Inițiază generarea unui video dintr-un prompt text.
GET /v1/videos/{id}
Verifică starea unui video în curs de generare și recuperează URL-ul rezultatului odată ce acesta este finalizat.
POST /v1/videos/edits
Editează un video existent.
POST /v1/videos/extensions
Extinde un video existent.
Sinteza vocală
POST /v1/tts
Convertește textul în audio (text-to-speech). Util pentru construirea asistenților vocali sau a conținutului audio automatizat.
Agent vocal în timp real
WSS wss://api.x.ai/v1/realtime
Un endpoint WebSocket pentru construirea agenților vocali interactivi. Comunicarea are loc în timp real, prin trimiterea și recepționarea de audio.
Gestionarea fișierelor
POST /v1/files
Încarcă un fișier pe platforma xAI. Fișierele pot fi apoi utilizate pentru RAG (generare augmentată prin recuperare) cu colecții.
GET /v1/files
Listează toate fișierele încărcate în spațiul dumneavoastră.
GET /v1/files/{id}
Recuperează metadatele unui fișier specific.
DELETE /v1/files/{id}
Șterge un fișier încărcat.
Procesarea în loturi
POST /v1/batches
Creează un lot de cereri pentru a fi procesate ca un grup, adesea la un preț redus.
GET /v1/batches
Listează loturile în curs de desfășurare și pe cele finalizate.
Instrumente integrate lato-server
Endpointul /v1/responses suportă instrumente pe care API-ul le execută direct, fără logică lato-client:
- web_search: căutare pe web în timp real
- x_search: căutare în postările X (Twitter)
- code_interpreter: executarea codului Python
- function: apeluri de funcții personalizate (function calling)
Activați aceste instrumente folosind parametrul tools al cererii.
Puncte cheie
- API-ul acoperă text, imagini, video, audio și fișiere
/v1/responseseste endpointul principal, oferind cea mai completă suportare- Modul
deferredpermite procesarea asincronă pentru cererile lungi - Instrumentele lato-server (web_search, x_search, code_interpreter) îmbogățesc răspunsurile fără cod suplimentar