Erstellen einer Antwort mit POST /v1/responses
Auf dieser Seite
Ihr erster Aufruf
Der Endpunkt POST /v1/responses ist der Haupteingang für die Responses API. Hier senden Sie Ihre Prompts und erhalten Antworten von Grok-Modellen. In dieser Lektion erfahren Sie, wie Sie Ihren ersten Aufruf erstellen und senden.
Authentifizierung
Alle Anfragen erfordern einen Authentifizierungshinterkopf mit Ihrem xAI API-Schlüssel:
Authorization: Bearer $XAI_API_KEY
Sie können Ihre Schlüssel unter console.x.ai generieren. Halten Sie diese geheim – geben Sie sie niemals in ein Git-Repository ein.
Minimaler Aufruf
Hier ist der einfachstmögliche Aufruf:
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."
}'
Zwei Felder reichen aus:
model: Die ID des zu verwendenden Grok-Modellsinput: Ihr Prompt als reiner Text
Mit dem Python-SDK
Wenn Sie das OpenAI SDK (xAI-kompatibel) verwenden, ist die Syntax ähnlich:
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)
Einfacher vs. strukturierter Eingabe
Der Parameter input akzeptiert zwei Formate.
Reiner Text
{
"model": "grok-4.20-0309-reasoning",
"input": "What is the capital of France?"
}
Strukturiertes Array
Für multimodale Eingaben oder explizite Rollen:
{
"model": "grok-4.20-0309-reasoning",
"input": [
{
"role": "user",
"content": "Analyze this image and describe what you see."
}
]
}
Das Array-Format bietet Ihnen mehr Kontrolle, insbesondere wenn Sie Bilder einbeziehen oder verschiedene Rollen angeben möchten.
Der instructions-Parameter
Um dem Modell ein Systemverhalten zu geben, verwenden Sie instructions statt eine Systemnachricht in input hinzuzufügen:
{
"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?"
}
Das Feld instructions entspricht dem system prompt bei Chat Completions. Es definiert das allgemeine Verhalten des Modells für den gesamten Gesprächsverlauf.
Praktische Übung
Versuchen Sie, einen Aufruf zu erstellen, der:
- Das Modell
grok-4.20-0309-reasoningverwendet - Systemanweisungen für einen technischen Assistenten definiert
- Eine Frage zu Python stellt
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?"
}'
Wichtige Erkenntnisse
POST /v1/responsesist der Haupteingang – er erfordertmodelundinputinputakzeptiert reinen Text oder ein strukturiertes Array mit Rolleninstructionsdefiniert das Systemverhalten des Modells- Die Authentifizierung erfolgt über den
Authorization: Bearer-Hinterkopf - Das OpenAI SDK ist mit xAI kompatibel, wenn Sie die
base_urländern