Tilgængelige endpoints
På denne side
Oversigt over Grok API
xAI API er ikke begrænset til tekstgenerering. Det eksponerer en række endpoints, der dækker billede- og videogenerering, talesyntese, filhåndtering og asynkron behandling. Denne lektion kortlægger de tilgængelige endpoints, så du ved, hvilke funktioner du skal bruge i dine projekter.
Tekstgenerering
POST /v1/responses (anbefales)
Dette er hoved-endpointet for al interaktion med Grok-modellerne. Det understøtter tekst, vision, værktøjer (funktionskald), websøgning og X-søgning.
Nøgleparametre: model, input, instructions, stream, tools, reasoning.
POST /v1/chat/completions (OpenAI-kompatibel)
Dette endpoint følger OpenAI-formatet og vedligeholdes for kompatibilitet med eksisterende værktøjer. Det accepterer de samme parametre som OpenAI API: model, messages, temperature, stream, tools.
GET /v1/responses/{id}
Henter et tidligere genereret svar, hvis det blev gemt (parameteren store: true). Svar opbevares i 30 dage.
DELETE /v1/responses/{id}
Sletter et gemt svar, før det udløber automatisk efter 30 dage.
Asynkron behandling
POST /v1/chat/completions (udskudt tilstand)
Når du tilføjer "deferred": true til anmodningen, returnerer API straks et request_id uden at vente på, at genereringen bliver færdig. Det er nyttigt til lange anmodninger eller batch-behandling.
GET /v1/chat/deferred-completion/{request_id}
Henter resultatet af et asynkront kald:
- HTTP 200: Genereringen er afsluttet, og body indeholder det komplette svar
- HTTP 202: Genereringen er stadig i gang, så prøv igen senere
Billedgenerering
POST /v1/images/generations
Genererer billeder ud fra en tekstbeskrivelse.
POST /v1/images/edits
Redigerer et eksisterende billede baseret på tekstinstruktioner.
Videogenerering
POST /v1/videos/generations
Starter generering af en video ud fra en tekstprompt.
GET /v1/videos/{id}
Tjekker status for en video, der er under generering, og henter resultat-URL’en, når den er færdig.
POST /v1/videos/edits
Redigerer en eksisterende video.
POST /v1/videos/extensions
Forlænger en eksisterende video.
Talesyntese
POST /v1/tts
Konverterer tekst til lyd (text-to-speech). Nyttigt til at bygge voice assistants eller automatiseret lydindhold.
Voice-agent i realtid
WSS wss://api.x.ai/v1/realtime
Et WebSocket-endpoint til at bygge interaktive voice-agenter. Kommunikationen foregår i realtid med send og modtag af lyd.
Filhåndtering
POST /v1/files
Uploader en fil til xAI-platformen. Filer kan derefter bruges til RAG (retrieval-augmented generation) med samlinger.
GET /v1/files
Lister alle filer, der er uploadet til dit område.
GET /v1/files/{id}
Henter metadata for en specifik fil.
DELETE /v1/files/{id}
Sletter en uploadet fil.
Batch-behandling
POST /v1/batches
Opretter en batch af anmodninger til behandling som en gruppe, ofte til en reduceret pris.
GET /v1/batches
Lister igangværende og fuldførte batches.
Indbyggede server-side værktøjer
Endpointet /v1/responses understøtter værktøjer, som API kører direkte uden klient-side logik:
- web_search: websøgning i realtid
- x_search: søgning i X (Twitter)-indlæg
- code_interpreter: kørsel af Python-kode
- function: brugerdefinerede funktionskald (function calling)
Du aktiverer disse værktøjer med anmodningens parameter tools.
Vigtige pointer
- API dækker tekst, billeder, video, lyd og filer
/v1/responseser hoved-endpointet med den mest komplette understøttelse- Tilstanden
deferredmuliggør asynkron behandling af lange anmodninger - Server-side værktøjer (web_search, x_search, code_interpreter) beriger svar uden ekstra kode