Käytettävissä olevat päätepisteet
Tällä sivulla
Yleiskatsaus Grok API:hin
xAI API ei rajoitu pelkkään tekstin tuottamiseen. Se tarjoaa joukon päätepisteitä kuvien ja videoiden generointiin, puheen synteesiin, tiedostojen hallintaan sekä asynkroniseen käsittelyyn. Tämä oppitunti kartoittaa käytettävissä olevat päätepisteet, jotta tiedät, mitkä ominaisuudet ottaa käyttöön projekteissasi.
Tekstin tuottaminen
POST /v1/responses (suositeltu)
Tämä on ensisijainen päätepiste kaikkeen vuorovaikutukseen Grok-mallien kanssa. Se tukee tekstiä, kuvantunnistusta (vision), työkaluja (funktiokutsut), verkkohakua ja X-hakua.
Keskeiset parametrit: model, input, instructions, stream, tools, reasoning.
POST /v1/chat/completions (OpenAI-yhteensopiva)
Tämä päätepiste noudattaa OpenAI-muotoilua ja on säilytetty yhteensopivuuden vuoksi olemassa olevien työkalujen kanssa. Se hyväksyy samat parametrit kuin OpenAI API: model, messages, temperature, stream, tools.
GET /v1/responses/{id}
Noutaa aiemmin generoidun vastauksen, jos se on tallennettu (parametri store: true). Vastaukset säilyvät 30 päivää.
DELETE /v1/responses/{id}
Poistaa tallennetun vastauksen ennen sen automaattista vanhenemista 30 päivän kuluttua.
Asynkroninen käsittely
POST /v1/chat/completions (viivästetty tila)
Kun lisäät pyyntöön "deferred": true, API palauttaa välittömästi request_id:n odottamatta generoinnin valmistumista. Tämä on hyödyllistä pitkiä pyyntöjä tai eräajoa varten.
GET /v1/chat/deferred-completion/{request_id}
Noutaa asynkronisen kutsun tuloksen:
- HTTP 200: generointi on valmis, ja runko sisältää täydellisen vastauksen
- HTTP 202: generointi on edelleen käynnissä, joten yritä myöhemmin uudelleen
Kuvien generointi
POST /v1/images/generations
Generoi kuvia tekstikuvauksen perusteella.
POST /v1/images/edits
Muokkaa olemassa olevaa kuvaa tekstiohjeiden perusteella.
Videoiden generointi
POST /v1/videos/generations
Aloittaa videon generoinnin tekstikehotteesta.
GET /v1/videos/{id}
Tarkistaa generoitavan videon tilan ja noutaa tulos-URL:n, kun video on valmis.
POST /v1/videos/edits
Muokkaa olemassa olevaa videota.
POST /v1/videos/extensions
Jatkaa olemassa olevaa videota.
Puheen synteesi
POST /v1/tts
Muuntaa tekstin ääneksi (text-to-speech). Hyödyllinen ääniavustajien tai automatisoidun äänisisällön rakentamiseen.
Reaaliaikainen puheagentti
WSS wss://api.x.ai/v1/realtime
WebSocket-päätepiste interaktiivisten puheagenttien rakentamiseen. Viestintä tapahtuu reaaliajassa lähettämällä ja vastaanottamalla ääntä.
Tiedostojen hallinta
POST /v1/files
Lataa tiedoston xAI-alustalle. Tiedostoja voidaan tämän jälkeen käyttää RAG:ssä (retrieval-augmented generation) kokoelmien kanssa.
GET /v1/files
Luettelee kaikki tilaasi ladatut tiedostot.
GET /v1/files/{id}
Noutaa tietyn tiedoston metatiedot.
DELETE /v1/files/{id}
Poistaa ladatun tiedoston.
Eräajon käsittely
POST /v1/batches
Luo joukon pyyntöjä käsiteltäväksi ryhmänä, usein edullisempaan hintaan.
GET /v1/batches
Luettelee käynnissä olevat ja valmistuneet erät.
Palvelinpuolen sisäänrakennetut työkalut
Päätepiste /v1/responses tukee työkaluja, jotka API suorittaa suoraan ilman asiakaspuolen logiikkaa:
- web_search: reaaliaikainen verkkohaku
- x_search: haku X:n (Twitter) julkaisuista
- code_interpreter: Python-koodin suoritus
- function: mukautetut funktiokutsut (function calling)
Otat nämä työkalut käyttöön pyynnön tools-parametrilla.
Keskeiset asiat
- API kattaa tekstin, kuvat, videot, äänen ja tiedostot
/v1/responseson ensisijainen päätepiste, jossa on laajin tukideferred-tila mahdollistaa asynkronisen käsittelyn pitkiä pyyntöjä varten- Palvelinpuolen työkalut (web_search, x_search, code_interpreter) rikastuttavat vastauksia ilman lisäkoodia