Documentation de l'API du point de terminaison Ollama
Commencez à développer avec l'API LLM sans censure en quelques secondes. Ce guide couvre l'URL de base, l'authentification et l'intégration des SDK pour vos flux de travail API compatibles OpenAI.
URL de base et authentification
Utilisez l'URL de base fournie et une clé API pour chaque requête. Le point de terminaison est https://api.ollamaendpoint.com/v1Autorisation header en tant que jeton Bearer. Vous générez cette clé immédiatement après vous être connecté avec Google ou e-mail. La clé est unique par compte et remplace toute clé active précédente.
Première demande
Envoyez une complétion de chat standard pour générer du texte. L'ID du modèle est uncensored Et accepte les mêmes paramètres que les clients OpenAI standard. Cela fonctionne pour les tâches LLM NSFW ou la génération de contenu sans restrictions.
- Méthode : POST
- Point de terminaison :
/v1/chat/completions - Modèle :
uncensored
curl https://api.ollamaendpoint.com/v1/chat/completions \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [{"role": "user", "content": "Get the local ip address of this machine"}]
}'
Une réponse réussie renvoie le texte généré dans le tableau choices. Vérifiez le usage champ pour voir les comptes de tokens.
Intégration du SDK Python
Installez la bibliothèque officielle OpenAI et configurez l'URL de base. Cela vous permet d'utiliser le modèle ollama uncensored avec du code Python familier. Définissez le base_url et api_key avant d'initialiser le client. Le code reste compatible avec les SDK OpenAI existants.
from openai import OpenAI
client = OpenAI(base_url="https://api.ollamaendpoint.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)
Appelez le chat.completions.create méthode comme vous le feriez pour GPT. La structure de la réponse correspond aux attentes standard. Vous pouvez streamer ou obtenir des réponses complètes.
Intégration du SDK Node
Utilisez le package OpenAI Node.js pour interagir avec l'API. Configurez le client avec l'URL de base personnalisée et votre clé API. Cette approche fonctionne pour les applications côté serveur ou les fonctions edge. Le package gère automatiquement la sérialisation et les nouvelles tentatives.
import OpenAI from "openai";
const client = new OpenAI({ baseURL: "https://api.ollamaendpoint.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);
Invoquez le point de terminaison de complétion avec votre invite. La bibliothèque renvoie une promesse qui se résout en l'objet de réponse. Gérez les erreurs conformément aux codes de statut HTTP standards.
Réponses en streaming avec SSE
Activez le streaming en définissant stream: true dans votre requête. Le serveur retourne un flux de Server-Sent Events (SSE). Chaque chunk contient du texte partiel et des données d'utilisation de tokens. Le dernier chunk inclut les statistiques d'utilisation complètes pour la facturation. Cela réduit la latence perçue pour les sorties longues.
stream = 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)
Accumulez les parties de contenu de chaque morceau pour reconstituer la réponse complète. Traitez les erreurs au fur et à mesure de leur arrivée dans le flux. Le dernier morceau confirme le nombre de jetons pour votre crédit prépayé.
Limites de débit et contraintes
Chaque clé API prend en charge 300 requêtes par minute et 8 requêtes simultanées. La taille maximale du corps de la requête est de 8 Mo. La fenêtre de contexte est de 100 000 jetons pour l'invite et la complétion combinées. Les limites de sortie sont de 16 000 jetons par requête. Les erreurs et les refus ne consomment pas de crédit. Une erreur 401 signifie que votre clé est invalide. Une erreur 402 indique un crédit prépayé insuffisant. Une erreur 429 signifie que vous avez atteint la limite de débit. Ajustez votre concurrence pour rester dans les limites.
FAQ
Quelle est l'URL de base pour le point de terminaison ollama ?
L'URL de base est HTTPS://api.ollamaendpoint.com/v1. Utilisez ceci pour tous les appels API. Elle est compatible avec les clients OpenAI standard.
Comment gérer les réponses en streaming ?
Définissez le paramètre stream sur true. L'API renvoie des événements envoyés par le serveur. Traitez chaque fragment pour reconstruire le texte final. Le dernier fragment inclut les données d'utilisation.
Que se passe-t-il si je touche une limite de taux ?
Vous recevez le code de statut 429. La limite est de 300 requêtes par minute par clé. Réduisez votre concurrence ou attendez avant de réessayer. Les requêtes simultanées sont limitées à 8.
Obtenez votre clé API
Inscrivez-vous, récupérez la clé, pointez vers la nouvelle URL de base. C'est fait.