L-endpoint disponibbli
F'din il-paġna
Ħarsa ġenerali lejn il-Grok API
L-API ta’ xAI mhix limitata għall-ġenerazzjoni tat-test. Tesponi sett ta’ endpoints li jkopru l-ġenerazzjoni ta’ stampi u vidjows, is-sinteżi tal-kliem, il-ġestjoni tal-fajls, u l-ipproċessar asinkronu. Din il-lezzjoni timmappja l-endpoints disponibbli biex tkun taf liema karatteristiċi tuża fil-proġetti tiegħek.
Ġenerazzjoni tat-test
POST /v1/responses (rakkomandat)
L-endpoint prinċipali għal kwalunkwe interazzjoni mal-mudelli Grok. Jappoġġja t-test, il-viżjoni, l-għodod (sejħa tal-funzjonijiet), it-tiftix fuq il-web, u t-tiftix fuq X.
Parametri ewlenin: model, input, instructions, stream, tools, reasoning.
POST /v1/chat/completions (kompatibbli ma’ OpenAI)
L-endpoint fil-format ta’ OpenAI, miżmum għall-kompatibbiltà ma’ għodod eżistenti. Jaċċetta l-istess parametri bħall-API ta’ OpenAI: model, messages, temperature, stream, tools.
GET /v1/responses/{id}
Jirkupra tweġiba ġġenerata preċedentement jekk kienet maħżuna (il-parametru store: true). It-tweġibiet jinżammu għal 30 jum.
DELETE /v1/responses/{id}
Jħassar tweġiba maħżuna qabel ma tiskadi awtomatikament wara 30 jum.
Ipproċessar asinkronu
POST /v1/chat/completions (modalità differita)
Meta żżid "deferred": true mat-talba, l-API tirritorna immedjatament request_id mingħajr ma tistenna sa ma tintemm il-ġenerazzjoni. Dan huwa utli għal talbiet twal jew għall-ipproċessar bil-kwantità (batch).
GET /v1/chat/deferred-completion/{request_id}
Jirkupra r-riżultat ta’ sejħa asinkrona:
- HTTP 200: il-ġenerazzjoni lesta, u l-korp fih it-tweġiba sħiħa
- HTTP 202: il-ġenerazzjoni għadha għaddejja, allura erġa’ pprova aktar tard
Ġenerazzjoni tal-immaġni
POST /v1/images/generations
Tiġġenera stampi minn deskrizzjoni testwali.
POST /v1/images/edits
Teditja stampa eżistenti bbażata fuq istruzzjonijiet testwali.
Ġenerazzjoni tal-vidjo
POST /v1/videos/generations
Jibda l-ġenerazzjoni ta’ vidjo minn prompt testwali.
GET /v1/videos/{id}
Jiċċekkja l-istatus ta’ vidjo li qed jiġi ġġenerat u jirkupra l-URL tar-riżultat ladarba jkun lest.
POST /v1/videos/edits
Jeditja vidjo eżistenti.
POST /v1/videos/extensions
Jestendi vidjo eżistenti.
Sinteżi tal-kliem
POST /v1/tts
Tikkonverti t-test f’awdjo (text-to-speech). Utli għall-bini ta’ assistenti bil-vuċi jew kontenut awdjo awtomatizzat.
Aġent tal-vuċi f’ħin reali
WSS wss://api.x.ai/v1/realtime
Endpoint WebSocket għall-bini ta’ aġenti interattivi bil-vuċi. Il-komunikazzjoni sseħħ f’ħin reali, billi tibgħat u tirċievi awdjo.
Ġestjoni tal-fajls
POST /v1/files
Jitla’ fajl fuq il-pjattaforma xAI. Il-fajls imbagħad jistgħu jintużaw għar-RAG (retrieval-augmented generation) ma’ kollezzjonijiet.
GET /v1/files
Jelenka l-fajls kollha mtellgħa fl-ispazju tiegħek.
GET /v1/files/{id}
Jirkupra l-metadejta ta’ fajl speċifiku.
DELETE /v1/files/{id}
Jħassar fajl imtella’.
Ipproċessar bil-kwantità (Batch)
POST /v1/batches
Joħloq kwantità (batch) ta’ talbiet biex jiġu pproċessati bħala grupp, spiss bi prezz imnaqqas.
GET /v1/batches
Jelenka l-kwantitajiet (batches) li għadhom għaddejjin u dawk lesti.
Għodod integrati fuq is-server
L-endpoint /v1/responses jappoġġja għodod li l-API tħaddem direttament, mingħajr loġika fuq in-naħa tal-klijent:
- web_search: tiftix fuq il-web f’ħin reali
- x_search: tiftix fil-postijiet fuq X (Twitter)
- code_interpreter: eżekuzzjoni tal-kodiċi Python
- function: sejħiet ta’ funzjonijiet personalizzati (function calling)
Tixgħel dawn l-għodod bil-parametru tools tat-talba.
Punti Ewlenin
- L-API tkopri t-test, l-immaġni, il-vidjo, l-awdjo u l-fajls
/v1/responseshuwa l-endpoint prinċipali, bl-aktar appoġġ sħiħ- Il-modalità
deferredtippermetti l-ipproċessar asinkronu għal talbiet twal - L-għodod fuq is-server (web_search, x_search, code_interpreter) jarricchixxu t-tweġibiet mingħajr kodiċi addizzjonali