Documentation API compatible OpenAI

URL de base et authentification

Commencez par configurer votre client avec l'URL de base et la clé API correctes. Le service fonctionne à https://api.compatibleaiopen.com/v1. Vous obtenez une clé via le tableau de bord en utilisant Google ou e-mail. La clé authentifie chaque requête au point de terminaison.

Première demande

Envoyez une requête standard de complétion de chat en utilisant l' uncensored ID du modèle. L'API accepte une entrée textuelle et retourne une sortie textuelle. Vous pouvez ajuster des paramètres tels que temperature ou top_p. La fenêtre de contexte prend en charge jusqu'à 100 000 tokens combinés pour l'invite et la complétion.

Copycurl https://api.compatibleaiopen.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List three benefits of local inference"}]
  }'

Intégration du SDK Python

Mettre à jour le base_url le paramètre dans le client Python OpenAI. Cela vous permet d'utiliser la même bibliothèque que vous connaissez déjà. L'identifiant du modèle reste uncensored. Le streaming et l'utilisation des outils fonctionnent exactement comme documenté pour OpenAI. Vous n'avez pas besoin de réécrire la logique de votre application.

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.compatibleaiopen.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)

Intégration du SDK Node

Configurez le client Node.js avec la nouvelle URL de base. Transmettez votre clé API via l'environnement ou l'initialisation du client. Le point de terminaison prend en charge tous les paramètres standard. Les erreurs renvoient des codes d'état HTTP standard. Vous pouvez l'intégrer immédiatement dans des fonctions Express ou serverless existantes.

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.compatibleaiopen.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);

Réponses en streaming

Activez le streaming en définissant stream à true. L'API renvoie des Server-Sent Events (SSE). Les données d'utilisation des jetons apparaissent dans le dernier fragment. Cela réduit la latence perçue pour les utilisateurs. Vous pouvez analyser les fragments de manière incrémentale. Le modèle gère les longs contextes sans perdre de jetons.

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)

Limites et erreurs

Vous êtes limité à 300 requêtes par minute par clé. Les requêtes simultanées sont plafonnées à 8 par clé. Les corps de requête doivent rester inférieurs à 8 Mo. Une erreur 401 indique une clé invalide. Une erreur 402 signifie que vous n'avez plus de crédit. Une erreur 429 signale une limitation de débit. Le crédit n'expire jamais. Les erreurs et les refus sont gratuits.