An bun-URL don API
Ar an leathanach seo
An pointe iontrála don Grok API
Téann gach iarratas chuig API xAI trí bhun-URL amháin. Tá sé ríthábhachtach an tURL sin agus na críochphointí atá ar fáil a thuiscint sula scríobhann tú do chéad líne cóid.
An bun-URL
Tá an Grok API lonnaithe ag an seoladh seo:
https://api.x.ai/v1
Is é an tURL seo an fhréamh do gach críochphointe. Mar shampla, chun freagra a chruthú, is é an tURL iomlán ná https://api.x.ai/v1/responses.
Cén fáth /v1?
Léiríonn an réimír /v1 leagan an API. Ligeann leaganú do xAI an tAPI a fhorbairt gan feidhmchláir atá ann cheana a bhriseadh. Má thagann leagan 2 chun cinn, beidh sé i gcomhfhogas le v1 le linn tréimhse aistrithe.
Comhoiriúnacht le héiceachóras OpenAI
Is gné bhunúsach de API xAI é a chomhoiriúnacht le formáid OpenAI. Go praiticiúil, má tá cód agat cheana féin a oibríonn le API OpenAI, ní gá duit ach dhá shocrú a athrú chun Grok a úsáid:
- An bun-URL: cuir
https://api.x.ai/v1in ionadhttps://api.openai.com/v1 - An eochair API: cuir d’eochair xAI in ionad d’eochair OpenAI
Síneann an chomhoiriúnacht sin chuig an chuid is mó de na huirlisí agus na leabharlanna in éiceachóras OpenAI: oibríonn LangChain, LlamaIndex, LiteLLM, agus go leor eile le Grok gan aon athrú cóid.
Na príomhchríochphointí
Nochtann an API roinnt críochphointí grúpáilte de réir gné.
Giniúint téacs
POST /v1/responses: an príomhchríochphointe chun freagraí a ghiniúint (formáid nua-aimseartha)POST /v1/chat/completions: an críochphointe atá comhoiriúnach le OpenAI (formáid oidhreachta, fós tacaithe)
Giniúint meán
POST /v1/images/generations: íomhánna a ghiniúintPOST /v1/images/edits: íomhánna atá ann cheana a chur in eagarPOST /v1/videos/generations: físeáin a ghiniúintPOST /v1/tts: sintéis cainte (téacs-go-labhra)
Bainistíocht comhad
POST /v1/files: comhad a uaslódáilGET /v1/files: liosta de chomhaid uaslódáilte
Fíor-am
wss://api.x.ai/v1/realtime: gníomhaire gutha thar WebSocket
Socraigh an URL i do SDKanna
Nuair a úsáideann tú SDK atá comhoiriúnach le OpenAI, caithfidh tú an bun-URL a shonrú go sainráite:
from openai import OpenAI
client = OpenAI(
api_key="xai-your-key",
base_url="https://api.x.ai/v1"
)
Le SDK dúchasach xAI, tá an URL réamhshocraithe agus ní gá duit aon rud a shocrú.
Tástáil an nascacht
Sula scríobhann tú aon chód, bailíochtaíonn glao díreach an slabhra iomlán (URL, eochair, líonra):
curl https://api.x.ai/v1/models \
-H "Authorization: Bearer xai-your-key"
Liostaíonn an freagra na samhlacha atá ar fáil le d’eochair. Is é seo freisin an bealach is iontaofa chun na haitheantóirí samhlacha cruinne atá ar fáil ar do chuntas a fhoghlaim, gan brath ar dhoiciméadú a d’fhéadfadh athrú. Coinnigh an nós seo: bailíochtaigh gach timpeallacht nua (meaisín, CI, freastalaí) leis an nglao céanna seo roimh aon imlonnú.
Teorainneacha agus cuótaí
Cuirtear teorainneacha ráta i bhfeidhm ar an API do gach foireann agus do gach samhail. Má sháraíonn tú iad, gheobhaidh tú earráid HTTP 429. Taispeánann consól xAI do chuótaí reatha agus d’úsáid i bhfíor-am.
Príomhphointí
- Is é
https://api.x.ai/v1an bun-URL do gach críochphointe - Tá an API comhoiriúnach le formáid OpenAI: athraigh an tURL agus an eochair, agus sin é
- Is é
POST /v1/responsesan príomhchríochphointe giniúna - Tá an críochphointe oidhreachta
POST /v1/chat/completionsar fáil fós le haghaidh comhoiriúnachta