Documentation API & Démarrage rapide

URL de base et authentification

Utilisez notre URL de base et une seule clé API pour vous connecter. Le point de terminaison accepte les en-têtes standard. Remplacez YOUR_API_KEY avec la chaîne de votre tableau de bord.

• URL de base : https://api.ollamaopenaicompatibleapi.com/v1
• ID du modèle : uncensored

L'authentification repose sur un jeton bearer. Passez-le dans le Authorization header. Cela assure la compatibilité avec n'importe quel client compatible SDK OpenAI. Vous pouvez générer une nouvelle clé instantanément via Google ou e-mail. Aucun numéro de téléphone n'est requis.

Point de terminaison Chat Completions

Envoyez une requête POST à /v1/chat/completions. Incluez votre tableau de messages et le nom du modèle. L'API renvoie une sortie textuelle basée sur votre invite. Cela fonctionne avec tout fournisseur utilisant des paramètres standard.

Définissez la température pour la créativité ou gardez-la basse pour la précision. Vous pouvez également définir des séquences d'arrêt. Le serveur traite la demande et renvoie la complétion. Il s'agit de l'interaction principale pour la plupart des intégrations.

N'oubliez pas que les erreurs ne consomment pas votre crédit prépayé. Seules les complétions réussies sont facturées. Cela protège votre budget pendant les phases de débogage.

Copycurl https://api.ollamaopenaicompatibleapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the top 10 Linux kernel security patches from 2023"}]
  }'

Réponses en streaming via SSE

Activez le streaming en définissant stream: true. Le serveur envoie des fragments au fur et à mesure de leur génération. Cela réduit considérablement la latence perçue. Vous recevez des réponses partielles en temps réel.

Analysez le flux Server-Sent Events. Le dernier chunk contient les statistiques d'utilisation. Cela inclut les compteurs de tokens pour l'entrée et la sortie. Vous pouvez suivre les coûts dynamiquement pendant la génération.

Cette approche fonctionne bien pour les interfaces de chat. Les utilisateurs voient le texte apparaître mot par mot. Cela semble plus réactif que d'attendre la réponse complète. L'API gère automatiquement la stabilité de la connexion.

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)

Appel de fonction et mode JSON

Définissez les outils dans le corps de votre requête. Le modèle peut générer des données structurées. Utilisez response_format avec {"type": "json_object"} pour du JSON strict. Cela garantit une sortie analysable à chaque fois.

Les définitions d'outils incluent le nom, la description et les paramètres. Le modèle décide quel outil appeler. Vous exécutez la fonction et renvoyez les résultats. Cela permet des workflows d'agents complexes.

Le mode JSON désactive la génération de texte libre. Il force le modèle à respecter votre schéma. Utilisez-le lors de l'intégration avec des bases de données ou des API. Cela réduit les hallucinations dans les champs structurés.

Copyfrom openai import OpenAI

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

Limites de débit et corps de requête

Vous bénéficiez de 300 requêtes par minute par clé. La concurrence est limitée à 8 requêtes simultanées. La taille maximale du corps de la requête est de 8 Mo. Cela convient à la plupart des applications axées sur le texte.

La fenêtre de contexte permet 100 000 jetons au total. Cela inclut à la fois la requête et la complétion. La sortie maximale par requête est de 16 000 jetons. Si vous omettez max_tokens, il est par défaut de 2 048.

Gérez les erreurs HTTP 429 de manière gracieuse. Elles indiquent que vous avez atteint la limite de débit. Mettez en œuvre une rétrogradation exponentielle dans le code de votre client. Cela empêche de surcharger le serveur lors des pics.

Copyimport OpenAI from "openai";

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

Erreurs d'authentification et limites

Un statut 401 signifie que votre clé est invalide. Vérifiez les fautes de frappe ou les sessions expirées. Un statut 402 indique un crédit insuffisant. Rechargez via crypto pour reprendre le service.

Un statut 429 signale une limitation de débit. Vous avez dépassé 300 requêtes par minute. Réduisez votre débit ou mettez à niveau votre clé. L'API renvoie des messages d'erreur clairs.

Le crédit n'expire jamais. Vous pouvez recharger à tout moment. Le minimum de recharge est de 20 $. Des crédits bonus s'appliquent pour les montants plus élevés. Cela maintient votre projet en bon fonctionnement.