Documentation API

Authentification et URL de base

L'URL de base pour toutes les requêtes est https://api.grokapiplatform.com/v1. Authentifiez-vous en passant votre clé API unique dans le Authorization header. Chaque requête doit inclure cet en-tête pour vérifier le solde de votre compte et appliquer les limites de débit.

Point de terminaison des complétions de chat

Envoyez des requêtes textuelles à POST /v1/chat/completions. L'ID du modèle à utiliser est "uncensored". Ce point de terminaison gère les interactions standard texte en entrée, texte en sortie sans configuration supplémentaire pour une utilisation de base.

Copycurl https://api.grokapiplatform.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Check my current token usage balance."}]
  }'

Le modèle fonctionne avec une fenêtre de contexte de 100,000 tokens. Les tokens d'entrée et de sortie partagent cette limite. Les requêtes dépassant la fenêtre de contexte échoueront immédiatement.

Réponses en streaming avec SSE

Activez le streaming en définissant stream: true dans le corps de votre requête. Le serveur renvoie des événements envoyés par le serveur (SSE) avec des mises à jour incrémentales de jetons. Utilisez ceci pour des affichages en temps réel ou pour réduire la latence perçue.

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.grokapiplatform.com/v1", api_key="YOUR_KEY")

resp = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Summarise this thread without softening it."}],
)
print(resp.choices[0].message.content)

Les détails d'utilisation des tokens apparaissent dans le dernier chunk du flux. Vous pouvez suivre la consommation totale par requête sans analyser chaque delta intermédiaire.

Appels de fonction et outils

Définissez des outils dans le tools tableau et définissez tool_choice pour déclencher des comportements spécifiques. Le modèle prend en charge les modèles d'utilisation d'outils standard compatibles avec les SDK OpenAI.

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.grokapiplatform.com/v1", apiKey: process.env.API_KEY });

const resp = await client.chat.completions.create({
  model: "uncensored",
  messages: [{ role: "user", content: "Draft a villain monologue for my game." }],
});
console.log(resp.choices[0].message.content);

Utiliser tool_choice: "auto" pour une sélection automatique ou spécifiez un nom d'outil pour une exécution forcée. Cela fonctionne parfaitement avec le modèle sans censure pour les tâches de raisonnement complexes.

Mode JSON pour une sortie structurée

Définir response_format à {"type": "json_object"} pour imposer une sortie JSON stricte. Cela réduit les erreurs d'analyse lors de l'intégration avec des applications frontend ou des pipelines de données.

Paramètres et limites

Ajuster temperature, top_p, et seed pour contrôler l'aléatoire. La sortie maximale par requête est de 16 000 tokens. Les erreurs comme 401 indiquent des clés invalides, 402 signifie un crédit prépayé insuffisant, et 429 signale des limites de taux. La limite est de 300 requêtes par minute par clé. Le crédit n'expire jamais, vous pouvez donc recharger avec USDT ou USDC quand vous le souhaitez.

Streaming

Copystream = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Tell the story in second person."}],
    stream=True,
)
for chunk in stream:
    if chunk.choices and chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="", flush=True)