API:n perusosoite
Tällä sivulla
Grok-API:n sisäänmenopiste
Jokainen xAI-API:n pyyntö kulkee yhden perusosoitteen kautta. Tämän osoitteen ja käytettävissä olevien päätepisteiden ymmärtäminen on välttämätöntä, ennen kuin kirjoitat ensimmäisen koodirivisi.
Perusosoite
Grok-API sijaitsee tässä osoitteessa:
https://api.x.ai/v1
Tämä URL on juuri kaikille päätepisteille. Esimerkiksi vastauksen luomiseksi täydellinen URL on https://api.x.ai/v1/responses.
Miksi /v1?
Etuliite /v1 kertoo API-version. Versionointi antaa xAI:lle mahdollisuuden kehittää API:ta rikkomatta olemassa olevia sovelluksia. Jos versio 2 julkaistaan, se toimii rinnakkain version v1 kanssa siirtymäkauden ajan.
Yhteensopivuus OpenAI-ekosysteemin kanssa
xAI-API:n perusominaisuus on sen yhteensopivuus OpenAI-muodon kanssa. Käytännössä, jos sinulla on jo koodia, joka toimii OpenAI-API:n kanssa, sinun tarvitsee vain muuttaa kahta asetusta käyttääksesi Grokia:
- Perusosoite: korvaa
https://api.openai.com/v1osoitteellahttps://api.x.ai/v1 - API-avain: korvaa OpenAI-avaimesi xAI-avaimellasi
Tämä yhteensopivuus ulottuu useimpiin OpenAI-ekosysteemin työkaluihin ja kirjastoihin: LangChain, LlamaIndex, LiteLLM ja monet muut toimivat Grokin kanssa ilman koodimuutoksia.
Tärkeimmät päätepisteet
API tarjoaa useita päätepisteitä, jotka on ryhmitelty ominaisuuksittain.
Tekstin tuottaminen
POST /v1/responses: ensisijainen päätepiste vastausten tuottamiseen (nykyaikainen muoto)POST /v1/chat/completions: OpenAI-yhteensopiva päätepiste (vanhentunut muoto, edelleen tuettu)
Median tuottaminen
POST /v1/images/generations: kuvien tuottaminenPOST /v1/images/edits: olemassa olevien kuvien muokkaaminenPOST /v1/videos/generations: videoiden tuottaminenPOST /v1/tts: puheensynteesi (tekstistä puheeksi)
Tiedostojen hallinta
POST /v1/files: tiedoston lataaminenGET /v1/files: ladattujen tiedostojen luettelointi
Reaaliaika
wss://api.x.ai/v1/realtime: ääniagentti WebSocketin yli
Osoitteen määrittäminen SDK:ssa
Kun käytät OpenAI-yhteensopivaa SDK:ta, sinun on määritettävä perusosoite erikseen:
from openai import OpenAI
client = OpenAI(
api_key="xai-your-key",
base_url="https://api.x.ai/v1"
)
Natiivissa xAI-SDK:ssa osoite on esiasetettu, joten sinun ei tarvitse määrittää mitään.
Yhteyden testaaminen
Ennen kuin kirjoitat mitään koodia, suora kutsu vahvistaa koko ketjun (osoite, avain, verkko):
curl https://api.x.ai/v1/models \
-H "Authorization: Bearer xai-your-key"
Vastaus luettelee avaimellesi saatavilla olevat mallit. Tämä on myös luotettavin tapa selvittää tilillesi saatavilla olevat tarkat mallitunnukset luottamatta dokumentaatioon, joka voi muuttua. Pidä tämä tapana: validoita jokainen uusi ympäristö (kone, CI, palvelin) tällä samalla kutsulla ennen käyttöönottoa.
Rajat ja kiintiöt
API valvoo nopeusrajoituksia jokaiselle tiimille ja jokaiselle mallille. Jos ylität ne, saat HTTP 429 -virheen. xAI-konsoli näyttää nykyiset kiintiösi ja käytön reaaliajassa.
Keskeiset asiat
- Perusosoite on
https://api.x.ai/v1kaikille päätepisteille - API on yhteensopiva OpenAI-muodon kanssa: vaihda osoite ja avain, siinä kaikki
- Ensisijainen tuotantopäätepiste on
POST /v1/responses - Vanhentunut
POST /v1/chat/completions-päätepiste on edelleen saatavilla yhteensopivuuden vuoksi