Tillgängliga slutpunkter
På denna sida
Översikt över Grok API
xAI API är inte begränsat till textgenerering. Det exponerar en uppsättning slutpunkter som täcker bild- och videogenerering, tal syntes, filhantering och asynkron bearbetning. Denna lektion kartlägger de tillgängliga slutpunkterna så att du vet vilka funktioner du ska använda i dina projekt.
Textgenerering
POST /v1/responses (rekommenderas)
Den huvudsakliga slutpunkten för all interaktion med Grok-modellerna. Den stöder text, vision, verktyg (funktionsanrop), webbsökning och X-sökning.
Viktiga parametrar: model, input, instructions, stream, tools, reasoning.
POST /v1/chat/completions (OpenAI-kompatibel)
Slutpunkten i OpenAI-format, underhållen för kompatibilitet med befintliga verktyg. Den accepterar samma parametrar som OpenAI API: model, messages, temperature, stream, tools.
GET /v1/responses/{id}
Hämtar ett tidigare genererat svar om det har lagrats (parametern store: true). Svar sparas i 30 dagar.
DELETE /v1/responses/{id}
Raderar ett lagrat svar innan det löper ut automatiskt efter 30 dagar.
Asynkron bearbetning
POST /v1/chat/completions (fördröjt läge)
När du lägger till "deferred": true i begäran returnerar API:et omedelbart ett request_id utan att vänta på att genereringen ska slutföras. Detta är användbart för långa begäranden eller batchbearbetning.
GET /v1/chat/deferred-completion/{request_id}
Hämtar resultatet av ett asynkront anrop:
- HTTP 200: genereringen är klar och brödtexten innehåller det kompletta svaret
- HTTP 202: genereringen pågår fortfarande, försök igen senare
Bildgenerering
POST /v1/images/generations
Genererar bilder från en textbeskrivning.
POST /v1/images/edits
Redigerar en befintlig bild baserat på textinstruktioner.
Videogenerering
POST /v1/videos/generations
Startar generering av en video från en textprompt.
GET /v1/videos/{id}
Kontrollerar status för en video som genereras och hämtar resultat-URL:n när den är klar.
POST /v1/videos/edits
Redigerar en befintlig video.
POST /v1/videos/extensions
Förlänger en befintlig video.
Talsyntes
POST /v1/tts
Omvandlar text till ljud (text-to-tal). Användbart för att bygga röstassistenter eller automatiserat ljudinnehåll.
Röstagent i realtid
WSS wss://api.x.ai/v1/realtime
En WebSocket-slutpunkt för att bygga interaktiva röstagenter. Kommunikationen sker i realtid genom att skicka och ta emot ljud.
Filhantering
POST /v1/files
Laddar upp en fil till xAI-plattformen. Filer kan sedan användas för RAG (retrieval-augmented generation) med samlingar.
GET /v1/files
Listar alla filer som laddats upp till ditt utrymme.
GET /v1/files/{id}
Hämtar metadata för en specifik fil.
DELETE /v1/files/{id}
Raderar en uppladdad fil.
Batchbearbetning
POST /v1/batches
Skapar en batch av begäranden som ska bearbetas som en grupp, ofta till ett reducerat pris.
GET /v1/batches
Listar pågående och slutförda batchar.
Inbyggda server-side-verktyg
Slutpunkten /v1/responses stöder verktyg som API:et kör direkt, utan någon klient-side-logik:
- web_search: webbsökning i realtid
- x_search: sökning i inlägg på X (Twitter)
- code_interpreter: körning av Python-kod
- function: anpassade funktionsanrop (function calling)
Du aktiverar dessa verktyg med begärans parameter tools.
Viktiga punkter
- API:t täcker text, bilder, video, ljud och filer
/v1/responsesär huvudslutpunkten med mest komplett stöd- Läget
deferredmöjliggör asynkron bearbetning för långa begäranden - Server-side-verktyg (web_search, x_search, code_interpreter) berikar svar utan extra kod