Skapa ett svar med POST /v1/responses
På denna sida
Din första förfrågan
Slutpunkten POST /v1/responses är huvudingången till Responses API. Det är här du skickar dina prompts och tar emot svar från Grok-modeller. I den här lektionen lär du dig hur du bygger och skickar din första förfrågan.
Autentisering
Alla förfrågningar kräver en autentiseringsheader med din xAI API-nyckel:
Authorization: Bearer $XAI_API_KEY
Du kan generera dina nycklar på console.x.ai. Håll dem hemliga – committa dem aldrig till ett Git-arkiv.
Minimal förfrågan
Här är den enklaste möjliga förfrågan:
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."
}'
Två fält räcker:
model: ID:t för Grok-modellen som ska användasinput: din prompt, som vanlig text
Med Python SDK
Om du använder OpenAI SDK (xAI-kompatibel) är syntaxen liknande:
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)
Enkel kontra strukturerad inmatning
Parametern input accepterar två format.
Vanlig text
{
"model": "grok-4.20-0309-reasoning",
"input": "What is the capital of France?"
}
Strukturerad array
För multimodal inmatning eller explicita roller:
{
"model": "grok-4.20-0309-reasoning",
"input": [
{
"role": "user",
"content": "Analyze this image and describe what you see."
}
]
}
Array-formatet ger dig mer kontroll, särskilt när du ska inkludera bilder eller ange olika roller.
Parametern instructions
För att ge modellen ett systembeteende använder du instructions istället för att lägga till ett systemmeddelande i 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?"
}
Fältet instructions motsvarar system prompt i Chat Completions. Det definierar modellens övergripande beteende för hela konversationen.
Praktisk övning
Försök bygga en förfrågan som:
- Använder modellen
grok-4.20-0309-reasoning - Definierar systeminstruktioner för en teknisk assistent
- Ställer en fråga om 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?"
}'
Viktiga punkter
POST /v1/responsesär huvudslutpunkten – den krävermodelochinputinputaccepterar vanlig text eller en strukturerad array med rollerinstructionsdefinierar modellens systembeteende- Autentisering sker via headern
Authorization: Bearer - OpenAI SDK är kompatibelt med xAI genom att ändra
base_url