Luo vastaus käyttämällä POST /v1/responses
Tällä sivulla
Ensimmäinen pyyntösi
POST /v1/responses on Responses API:n tärkein sisäänmenopiste. Tästä päätepisteestä lähetät kehotteesi ja saat vastaukset Grok-malleilta. Tässä oppitunnissa opit rakentamaan ja lähettämään ensimmäisen pyyntösi.
Todennus
Kaikki pyynnöt vaativat tunnistautumisotsikon, jossa on xAI API -avaimesi:
Authorization: Bearer $XAI_API_KEY
Voit luoda avaimesi osoitteessa console.x.ai. Pidä ne salassa – älä koskaan tallenna niitä Git-tietovarastoon.
Minimipyyntö
Tässä on yksinkertaisin mahdollinen pyyntö:
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."
}'
Kaksi kenttää riittää:
model: käytettävän Grok-mallin tunnisteinput: kehote pelkkänä tekstinä
Python SDK:n kanssa
Jos käytät OpenAI SDK:ta (yhteensopiva xAI:n kanssa), syntaksi on samankaltainen:
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)
Yksinkertainen vs. jäsennelty syöte
input-parametri hyväksyy kahta muotoa.
Pelkkä teksti
{
"model": "grok-4.20-0309-reasoning",
"input": "What is the capital of France?"
}
Jäsennelty taulukko
Multimodaalisia syötteitä tai eksplisiittisiä rooleja varten:
{
"model": "grok-4.20-0309-reasoning",
"input": [
{
"role": "user",
"content": "Analyze this image and describe what you see."
}
]
}
Taulukkomuoto antaa sinulle enemmän hallintaa, erityisesti kuvia lisättäessä tai eri rooleja määriteltäessä.
Ohjeistusparametri
Antaaksesi mallille järjestelmätason käyttäytymisohjeet, käytä instructions-kenttää äläkä lisää järjestelmäviestiä input-kenttään:
{
"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?"
}
instructions-kenttä vastaa Chat Completions -rajapinnan system prompt -kenttää. Se määrittelee mallin yleisen käyttäytymisen koko keskustelun ajaksi.
Käytännön harjoitus
Kokeile rakentaa pyyntö, joka:
- Käyttää
grok-4.20-0309-reasoning-mallia - Määrittelee järjestelmäohjeet teknistä avustajaa varten
- Esittää kysymyksen Pythonista
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?"
}'
Keskeiset asiat
POST /v1/responseson pääasiallinen päätepiste – se vaatiimodel- jainput-kentätinputhyväksyy pelkän tekstin tai rooleja sisältävän jäsennellyn taulukoninstructionsmäärittelee mallin järjestelmätason käyttäytymisen- Todennus tapahtuu
Authorization: Bearer-otsikon kautta - OpenAI SDK on yhteensopiva xAI:n kanssa muuttamalla
base_url-osoitetta