Documentation de l'API Ollama : Référence des points de terminaison

URL de base et authentification

L'URL de base pour toutes les requêtes est https://api.ollamaapidocumentation.com/v1. Vous vous authentifiez à l'aide d'un jeton bearer passé dans le Authorization header. Votre clé est générée sur le tableau de bord et fonctionne immédiatement.

• Utilisez les SDK officiels OpenAI ou n'importe quel client compatible.
• Définissez l'URL de base sur la valeur ci-dessus.
• Incluez votre clé API dans l'en-tête.

L'authentification est stricte. Si la clé est manquante ou invalide, l'API renvoie une erreur 401. Cela garantit que votre utilisation est suivie avec précision pour la facturation.

Point de terminaison Chat Completions : POST /v1/chat/completions

Envoyez des messages au modèle via POST /v1/chat/completions. Le point de terminaison accepte un corps JSON avec un model field set to "uncensored" and a messages tableau.

Ce point de terminaison gère la génération de texte. Il ne prend pas en charge les images, l'audio ou la vidéo. Vous pouvez diffuser les réponses ou attendre le résultat complet.

Les erreurs comme 402 indiquent un crédit insuffisant. Les requêtes sont facturées en fonction de l'utilisation réelle des jetons. Les refus dus au crédit sont gratuits.

Liste des modèles : GET /v1/models

Récupérez les modèles disponibles en utilisant GET /v1/models. Cela retourne une liste d'objets modèle. L'ID de modèle disponible est uniquement "uncensored".

Ce point de terminaison aide à vérifier la connectivité. Il confirme que l'URL de base est correcte. Il affiche également le nom du modèle et le type d'objet.

Utilisez ceci pour déboguer les problèmes de connexion avant d'envoyer des charges utiles lourdes.

Paramètres : Température, Top P et Seed

Maîtrisez la génération avec temperature, top_p, et seed. Le seed parameter garantit des sorties déterministes. Utilisez-le pour le débogage ou des résultats cohérents.

Définir temperature entre 0 et 2. Des valeurs plus basses rendent les réponses plus prévisibles. Des valeurs plus élevées augmentent l'aléatoire. Le top_p le paramètre filtre les tokens par probabilité cumulée.

Ces paramètres fonctionnent exactement comme l'API OpenAI. Vous pouvez les combiner pour un contrôle précis du style.

Réponses en streaming et consommation de jetons

Activez le streaming en définissant stream: true. L'API retourne des Server-Sent Events (SSE). Chaque chunk contient du texte partiel.

Le dernier chunk inclut les statistiques d'utilisation des jetons. Cela vous permet de calculer les coûts avec précision. Vous pouvez traiter les jetons à mesure qu'ils arrivent.

Le streaming réduit la latence perçue. Il est idéal pour les interfaces de chat. Le serveur envoie des données jusqu'à ce que la réponse soit complète.

Limites, Erreurs et Fenêtre de contexte

La fenêtre de contexte est de 100 000 tokens. Cela inclut les tokens d'entrée et de sortie. Vous pouvez générer jusqu'à 16 000 tokens par requête. La sortie maximale par défaut est de 2 048 tokens.

Les limites de débit sont de 300 requêtes par minute. Vous pouvez avoir 8 requêtes simultanées. La taille du corps de la requête est limitée à 8 Mo.

Les erreurs incluent 401 pour les clés invalides et 429 pour les limites de débit. Les erreurs de crédit renvoient 402. Ces erreurs sont claires et exploitables.

cURL

Copycurl https://api.ollamaapidocumentation.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list files in the current directory"}]
  }'

Python

Copyfrom openai import OpenAI

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

Node.js

Copyimport OpenAI from "openai";

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

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)