Looge vastus päringuga POST /v1/responses
Sellel lehel
Sinu esimene päring
Lõpp-punkt POST /v1/responses on Responses API peamine sisenemispunkt. Siin saadad oma vihjed (promptid) ja saad vastused Groki mudelitelt. Selles õppetükis õpid koostama ja saatma oma esimest päringut.
Autentimine
Kõik päringud nõuavad autentimispäist koos sinu xAI API võtmega:
Authorization: Bearer $XAI_API_KEY
Saad oma võtmed genereerida aadressil console.x.ai. Hoia neid saladuses – ära kunagi laadi neid Git’i hoidlasse.
Minimaalne päring
Siin on kõige lihtsam võimalik päring:
curl https://api.x.ai/v1/responses \
-H "Authorization: Bearer $XAI_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "grok-4.20-0309-reasoning",
"input": "Explain what machine learning is in 3 sentences."
}'
Piisab kahest väljast:
model: kasutatava Groki mudeli IDinput: sinu vihje lihttekstina
Kasutades Pythoni SDK-d
Kui kasutad OpenAI SDK-d (ühildub xAI-ga), on süntaks sarnane:
from openai import OpenAI
client = OpenAI(
api_key="xai-...",
base_url="https://api.x.ai/v1"
)
response = client.responses.create(
model="grok-4.20-0309-reasoning",
input="Explain what machine learning is in 3 sentences."
)
print(response.output[0].content[0].text)
Lihtne vs struktureeritud sisend
Parameeter input aktsepteerib kahte formaati.
Lihttekst
{
"model": "grok-4.20-0309-reasoning",
"input": "What is the capital of France?"
}
Struktureeritud massiiv
Multimodaalse sisendi või selgete rollide jaoks:
{
"model": "grok-4.20-0309-reasoning",
"input": [
{
"role": "user",
"content": "Analyze this image and describe what you see."
}
]
}
Massiivi formaat annab sulle rohkem kontrolli, eriti piltide lisamisel või erinevate rollide määramisel.
Parameeter instructions
Mudeli süsteemkäitumise määramiseks kasuta välja instructions, selle asemel et lisada süsteemsõnumit välja input:
{
"model": "grok-4.20-0309-reasoning",
"instructions": "You are a French cuisine expert. Always respond including a chef's tip.",
"input": "How do I make a successful béchamel?"
}
Väli instructions on samaväärne „süsteemse vihjega“ (system prompt) Chat Completionsis. See määratleb mudeli üldise käitumise kogu vestluse vältel.
Praktiline harjutus
Proovi koostada päring, mis:
- Kasutab mudelit
grok-4.20-0309-reasoning - Määratleb süsteemi juhised tehnilisele assistendile
- Esitab küsimuse Pythoni kohta
curl https://api.x.ai/v1/responses \
-H "Authorization: Bearer $XAI_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "grok-4.20-0309-reasoning",
"instructions": "You are a senior Python developer. Give concise code examples.",
"input": "How do I read a JSON file in Python?"
}'
Peamised punktid
POST /v1/responseson peamine lõpp-punkt – see nõuab väljumodeljainputinputaktsepteerib lihtteksti või struktureeritud massiivi rollidegainstructionsmääratleb mudeli süsteemkäitumise- Autentimine toimub päise
Authorization: Bearerkaudu - OpenAI SDK on xAI-ga ühilduv, kui muudad
base_url-i