Documentation API Compatible OpenAI

Guide de démarrage rapide : Connectez avec le SDK OpenAI

Commencez par vous authentifier avec votre clé et pointez le client vers notre URL de base. Cette configuration fonctionne avec les SDK officiels OpenAI pour Python et Node.js, garantissant que vous pouvez exécuter le même code client contre notre service. Vous avez besoin d'une clé API valide depuis le tableau de bord et de la configuration correcte du point de terminaison.

Copycurl https://api.openaiapicompatible.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Return the current UTC timestamp in ISO 8601 format"}]
  }'

Copyfrom openai import OpenAI

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

Copyimport OpenAI from "openai";

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

Point de terminaison Chat Completions

Envoyez du texte à notre point de terminaison de chat unique pour une sortie textuelle directe. Nous utilisons POST /v1/chat/completions pour traiter vos invites et retourner du texte généré. C'est l'interaction principale pour la plupart des applications LLM, sans nécessiter de routage complexe ni d'appels de service supplémentaires.

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)

Streaming avec SSE

Recevez des tokens en temps réel en utilisant les Server-Sent Events pour une latence plus faible. Activez le streaming en définissant le paramètre stream sur true dans votre requête. Le dernier chunk inclut les données d'utilisation des tokens, vous permettant de suivre les coûts avec précision au fur et à mesure de la génération de texte par le modèle. Cette approche maintient votre interface utilisateur réactive même pour les sorties longues.

Appel de fonctions et mode JSON

Intégrez les outils et imposez des sorties structurées pour des interactions programmatiques fiables. Utilisez le paramètre tools pour définir les schémas de fonctions et définissez response_format sur json_object pour une conformité JSON stricte. Notre modèle sans censure gère les instructions complexes et les cas limites sans refuser les requêtes fonctionnelles valides.

Limites de débit & Paramètres

Surveillez votre utilisation par rapport à des limites strictes par clé pour éviter les interruptions de service. Vous êtes autorisé à 300 requêtes par minute et à huit requêtes simultanées par clé, avec une limite de corps de 8 Mo. Les erreurs comme le 401 (clé invalide), le 402 (pas de crédit) et le 429 (limite de débit) indiquent des états de compte spécifiques.

Fenêtre de Contexte & Contraintes

Maximisez la gestion du contexte avec une fenêtre de 100 000 tokens pour l'entrée et la sortie combinées. Définissez max_tokens pour contrôler la longueur de la génération, par défaut 2 048 si non spécifié. Notre modèle s'exécute sur des serveurs propriétaires, et non comme proxy pour d'autres fournisseurs, garantissant des performances cohérentes pour votre cas d'utilisation spécifique.