Pieejamie galapunkti
Šajā lapā
Grok API pārskats
xAI API neaprobežojas tikai ar teksta ģenerēšanu. Tas piedāvā virkni galapunktu attēlu un video ģenerēšanai, runas sintēzei, failu pārvaldībai un asinhronai apstrādei. Šajā nodarbībā aplūkoti visi pieejamie galapunkti, lai tu zinātu, kuras funkcijas izmantot savos projektos.
Teksta ģenerēšana
POST /v1/responses (ieteicams)
Galvenais galapunkts jebkurai mijiedarbībai ar Grok modeļiem. Tas atbalsta tekstu, redzi (vision), rīkus (funkciju izsaukumus), meklēšanu tīmeklī un meklēšanu platformā X.
Galvenie parametri: model, input, instructions, stream, tools, reasoning.
POST /v1/chat/completions (saderīgs ar OpenAI)
Galapunkts OpenAI formātā, kas uzturēts saderībai ar esošajiem rīkiem. Tas pieņem tos pašus parametrus kā OpenAI API: model, messages, temperature, stream, tools.
GET /v1/responses/{id}
Iegūst iepriekš ģenerētu atbildi, ja tā tika saglabāta (parametrs store: true). Atbildes tiek glabātas 30 dienas.
DELETE /v1/responses/{id}
Dzēš saglabātu atbildi pirms tā automātiski beidzas pēc 30 dienām.
Asinhronā apstrāde
POST /v1/chat/completions (atliktā režīmā)
Pievienojot pieprasījumam "deferred": true, API nekavējoties atgriež request_id, negaidot ģenerēšanas pabeigšanu. Tas ir noderīgi garākiem pieprasījumiem vai pakešu apstrādei.
GET /v1/chat/deferred-completion/{request_id}
Iegūst asinhrona izsaukuma rezultātu:
- HTTP 200: ģenerēšana ir pabeigta, un ķermenī ir pilnīga atbilde
- HTTP 202: ģenerēšana vēl notiek, tāpēc mēģini vēlāk
Attēlu ģenerēšana
POST /v1/images/generations
Ģenerē attēlus, pamatojoties uz teksta aprakstu.
POST /v1/images/edits
Rediģē esošu attēlu, pamatojoties uz teksta instrukcijām.
Video ģenerēšana
POST /v1/videos/generations
Sāk video ģenerēšanu no teksta uzdevuma.
GET /v1/videos/{id}
Pārbauda ģenerējama video statusu un iegūst rezultāta URL, kad tas ir pabeigts.
POST /v1/videos/edits
Rediģē esošu video.
POST /v1/videos/extensions
Pagarina esošu video.
Runas sintēze
POST /v1/tts
Pārvērš tekstu audio formātā (teksts-runā). Noderīgi, veidojot balss asistentus vai automatizētu audio saturu.
Reāllaika balss aģents
WSS wss://api.x.ai/v1/realtime
WebSocket galapunkts interaktīvu balss aģentu veidošanai. Komunikācija notiek reāllaikā, sūtot un saņemot audio.
Failu pārvaldība
POST /v1/files
Augšupielādē failu xAI platformā. Failus pēc tam var izmantot RAG (retrieval-augmented generation) kopā ar kolekcijām.
GET /v1/files
Parāda visus tavā vietnē augšupielādētos failus.
GET /v1/files/{id}
Iegūst konkrēta faila metadatus.
DELETE /v1/files/{id}
Dzēš augšupielādētu failu.
Pakešu apstrāde
POST /v1/batches
Izveido pieprasījumu paku apstrādei kā grupu, bieži vien par zemāku cenu.
GET /v1/batches
Parāda notiekošās un pabeigtās pakas.
Servera pusē iebūvētie rīki
Galapunkts /v1/responses atbalsta rīkus, kurus API izpilda tieši, bez klienta puses loģikas:
- web_search: meklēšana tīmeklī reāllaikā
- x_search: meklēšana platformas X (Twitter) ierakstos
- code_interpreter: Python koda izpilde
- function: pielāgotu funkciju izsaukumi (function calling)
Šos rīkus aktivizē, izmantojot pieprasījuma parametru tools.
Galvenās atziņas
- API aptver tekstu, attēlus, video, audio un failus
/v1/responsesir galvenais galapunkts ar vispilnīgāko atbalstudeferredrežīms ļauj veikt asinhronu apstrādi gariem pieprasījumiem- Servera puses rīki (web_search, x_search, code_interpreter) bagātina atbildes, neprasa papildu kodu