Sukurk atsakymą naudodamas POST /v1/responses
Šiame puslapyje
Tavo pirmasis užklausa
POST /v1/responses galinis taškas yra pagrindinis Responses API įėjimo taškas. Čia siunči savo užuominas (prompts) ir gauni atsakymus iš Grok modelių. Šioje pamokoje išmoksi sudaryti ir išsiųsti savo pirmąją užklausą.
Autentifikavimas
Visoms užklausoms reikalinga autentifikavimo antraštė su tavo xAI API raktu:
Authorization: Bearer $XAI_API_KEY
Raktus gali sugeneruoti adresu console.x.ai. Laikyk juos paslaptyje – niekada neįkelk jų į Git saugyklą.
Minimali užklausa
Štai paprasčiausia galima užklausa:
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."
}'
Pakanka dviejų laukų:
model: naudojamo Grok modelio IDinput: tavo užuomina kaip paprastas tekstas
Naudojant Python SDK
Jei naudoji OpenAI SDK (suderinamą su xAI), sintaksė yra panaši:
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)
Paprasta contra struktūruota įvestis
Parametras input priima du formatus.
Paprastas tekstas
{
"model": "grok-4.20-0309-reasoning",
"input": "What is the capital of France?"
}
Struktūruotas masyvas
Naudojama multimodalinei įvestiai arba aiškiems vaidmenims nustatyti:
{
"model": "grok-4.20-0309-reasoning",
"input": [
{
"role": "user",
"content": "Analyze this image and describe what you see."
}
]
}
Masyvo formatas suteikia daugiau kontrolės, ypač įtraukiant vaizdus arba nurodant skirtingus vaidmenis.
Parametras instructions
Norėdamas nustatyti sisteminį modelio elgesį, naudok instructions, o ne pridėk sistemos žinutę į 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?"
}
Laukas instructions yra lygiavertis system prompt pokalbių užbaigimo (Chat Completions) kontekste. Jis apibrėžia bendrą modelio elgesį visam pokalbiui.
Praktinė užduotis
Pabandyk sudaryti užklausą, kuri:
- Naudotų modelį
grok-4.20-0309-reasoning - Apibrėžtų sistemos instrukcijas techniniam asistentui
- Užduotų klausimą apie Python
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?"
}'
Svarbiausi punktai
POST /v1/responsesyra pagrindinis galinis taškas – jam būtinimodelirinputinputpriima paprastą tekstą arba struktūruotą masyvą su vaidmenimisinstructionsapibrėžia sisteminį modelio elgesį- Autentifikavimas atliekamas per antraštę
Authorization: Bearer - OpenAI SDK yra suderinamas su xAI pakeitus
base_url