Η βασική URL του API
Σε αυτήν τη σελίδα
Το σημείο εισόδου του Grok API
Κάθε αίτημα προς το xAI API περνάει μέσω μίας και μοναδικής βασικής URL. Η κατανόηση αυτής της διεύθυνσης και των διαθέσιμων endpoint είναι απαραίτητη πριν γράψετε την πρώτη γραμμή κώδικα.
Η βασική URL
Το Grok API βρίσκεται στην ακόλουθη διεύθυνση:
https://api.x.ai/v1
Αυτή η URL αποτελεί τη ρίζα για κάθε endpoint. Για παράδειγμα, για τη δημιουργία μιας απάντησης, η πλήρης URL είναι https://api.x.ai/v1/responses.
Γιατί /v1;
Το πρόθεμα /v1 υποδεικνύει την έκδοση του API. Η διαχείριση εκδόσεων επιτρέπει στο xAI να εξελίσσει το API χωρίς να διακόπτει τη λειτουργία υφιστάμενων εφαρμογών. Εάν κυκλοφορήσει μια έκδοση 2, θα συνυπάρξει με την v1 κατά τη διάρκεια μιας μεταβατικής περιόδου.
Συμβατότητα με το οικοσύστημα της OpenAI
Ένα θεμελιώδες χαρακτηριστικό του xAI API είναι η συμβατότητά του με τη μορφή της OpenAI. Στην πράξη, εάν διαθέτετε ήδη κώδικα που λειτουργεί με το API της OpenAI, χρειάζεται να αλλάξετε μόνο δύο ρυθμίσεις για να χρησιμοποιήσετε το Grok:
- Η βασική URL: αντικαταστήστε το
https://api.openai.com/v1με τοhttps://api.x.ai/v1 - Το κλειδί API: αντικαταστήστε το κλειδί της OpenAI με το κλειδί xAI
Αυτή η συμβατότητα επεκτείνεται στα περισσότερα εργαλεία και βιβλιοθήκες του οικοσυστήματος της OpenAI: τα LangChain, LlamaIndex, LiteLLM και πολλά άλλα λειτουργούν με το Grok χωρίς αλλαγές στον κώδικα.
Τα κύρια endpoints
Το API εκθέτει διάφορα endpoints ομαδοποιημένα ανά λειτουργία.
Δημιουργία κειμένου
POST /v1/responses: το κύριο endpoint για τη δημιουργία απαντήσεων (σύγχρονη μορφή)POST /v1/chat/completions: το endpoint συμβατό με την OpenAI (παλαιότερη μορφή, vẫn υποστηρίζεται)
Δημιουργία πολυμέσων
POST /v1/images/generations: δημιουργία εικόνωνPOST /v1/images/edits: επεξεργασία υφιστάμενων εικόνωνPOST /v1/videos/generations: δημιουργία βίντεοPOST /v1/tts: σύνθεση ομιλίας (κείμενο σε ομιλία)
Διαχείριση αρχείων
POST /v1/files: μεταφόρτωση αρχείουGET /v1/files: λίστα μεταφορτωμένων αρχείων
Πραγματικός χρόνος
wss://api.x.ai/v1/realtime: φωνητικός πράκτορας μέσω WebSocket
Ορισμός της URL στα SDK σας
Όταν χρησιμοποιείτε ένα SDK συμβατό με την OpenAI, πρέπει να ορίσετε ρητά τη βασική URL:
from openai import OpenAI
client = OpenAI(
api_key="xai-your-key",
base_url="https://api.x.ai/v1"
)
Με το εγγενές SDK του xAI, η URL είναι προρυθμισμένη και δεν χρειάζεται να ορίσετε τίποτα.
Δοκιμή συνδεσιμότητας
Πριν γράψετε οποιονδήποτε κώδικα, μια άμεση κλήση επικυρώνει ολόκληρη την αλυσίδα (URL, κλειδί, δίκτυο):
curl https://api.x.ai/v1/models \
-H "Authorization: Bearer xai-your-key"
Η απάντηση παραθέτει τα μοντέλα που είναι διαθέσιμα με το κλειδί σας. Αυτός είναι επίσης ο πιο αξιόπιστος τρόπος για να μάθετε τα ακριβή αναγνωριστικά μοντέλων που είναι διαθέσιμα στον λογαριασμό σας, χωρίς να εξαρτάστε από τεκμηρίωση που ενδέχεται να αλλάξει. Διατηρήστε αυτή τη συνήθεια: επικυρώνετε κάθε νέο περιβάλλον (μηχάνημα, CI, διακομιστή) με την ίδια αυτή κλήση πριν από οποιαδήποτε ανάπτυξη.
Όρια και ποσοστώσεις
Το API επιβάλλει όρια ρυθμού για κάθε ομάδα και κάθε μοντέλο. Εάν τα υπερβείτε, θα λάβετε ένα σφάλμα HTTP 429. Η κονσόλα του xAI εμφανίζει τις τρέχουσες ποσοστώσεις σας και τη χρήση σας σε πραγματικό χρόνο.
Βασικά σημεία
- Η βασική URL είναι
https://api.x.ai/v1για κάθε endpoint - Το API είναι συμβατό με τη μορφή της OpenAI: αλλάξτε τη URL και το κλειδί, και αυτό είναι όλο
- Το κύριο endpoint δημιουργίας είναι το
POST /v1/responses - Το παλαιότερο endpoint
POST /v1/chat/completionsπαραμένει διαθέσιμο για λόγους συμβατότητας