Izveido atbildi, izmantojot POST /v1/responses
Šajā lapā
Tavs pirmais pieprasījums
Beigu punkts POST /v1/responses ir galvenā ieejas durvis Responses API. Tieši šeit tu nosūti savus uzdevumus (promptus) un saņem atbildes no Grok modeļiem. Šajā nodarbībā tu iemācīsies izveidot un nosūtīt savu pirmo pieprasījumu.
Autentifikācija
Visiem pieprasījumiem ir nepieciešama autentifikācijas galvene ar tavu xAI API atslēgu:
Authorization: Bearer $XAI_API_KEY
Atslēgas vari ģenerēt vietnē console.x.ai. Glabā tās noslēpumā – nekad neievieto tās Git repozitorijā.
Minimālais pieprasījums
Lūk, vienkāršākais iespējamais pieprasījums:
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."
}'
Pietiek ar diviem laukiem:
model: izmantojamā Grok modeļa IDinput: tavs uzdevums parasta teksta veidā
Izmantojot Python SDK
Ja izmanto OpenAI SDK (kas ir saderīgs ar xAI), sintakse ir līdzīga:
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)
Vienkārša pret strukturētu ievadi
Parametrs input pieņem divus formātus.
Parasts teksts
{
"model": "grok-4.20-0309-reasoning",
"input": "What is the capital of France?"
}
Strukturēta masīva forma
Multimodālai ievadei vai precīzu lomu norādīšanai:
{
"model": "grok-4.20-0309-reasoning",
"input": [
{
"role": "user",
"content": "Analyze this image and describe what you see."
}
]
}
Masīva formāts dod lielāku kontroli, it īpaši, ja jāiekļauj attēli vai jānorāda dažādas lomas.
Parametrs instructions
Lai noteiktu modeļa sistēmas uzvedību, izmanto instructions, nevis pievieno sistēmas ziņojumu laukā 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?"
}
Lauks instructions ir ekvivalents system prompt Chat Completions kontekstā. Tas definē modeļa vispārējo uzvedību visai sarunai.
Praktisks uzdevums
Mēģini izveidot pieprasījumu, kas:
- Izmanto modeli
grok-4.20-0309-reasoning - Definē sistēmas instrukcijas tehniskajam asistentam
- Uzdod jautājumu par 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?"
}'
Galvenās atziņas
POST /v1/responsesir galvenais beigu punkts – tas prasamodeluninputinputpieņem parastu tekstu vai strukturētu masīvu ar lomāminstructionsdefinē modeļa sistēmas uzvedību- Autentifikācija notiek, izmantojot galveni
Authorization: Bearer - OpenAI SDK ir saderīgs ar xAI, mainot
base_url