API Documentation

URL de base et authentification

L'API vit à l'adresse https://api.ollamaapidoc.com/v1. Vous vous authentifiez à l'aide d'un jeton Bearer dans le Authorization header. Générez votre clé instantanément via Google ou e-mail sur le tableau de bord. Aucun numéro de téléphone requis. La clé fonctionne avec les SDK OpenAI standard en définissant l'URL de base.

Votre première requête

Envoyez une requête POST à /v1/chat/completions avec l'ID du modèle uncensored. Ce point de terminaison gère l’entrée et la sortie de texte. Il prend en charge le streaming, le mode JSON et l’appel de fonctions. Vous pouvez tester la connectivité sans dépenser de crédit en vérifiant d’abord le point de terminaison des modèles.

Copycurl https://api.ollamaapidoc.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list all installed models"}]
  }'

La réponse retourne le format standard OpenAI. Les erreurs renvoient les codes HTTP appropriés. Vérifiez le corps pour error détails en cas d'échec. Les réponses en streaming utilisent les Server-Sent Events.

Intégration du SDK Python

Installez la bibliothèque officielle OpenAI. Configurez le client avec votre URL de base et votre clé API. Appelez le point de terminaison des complétions de chat. Le code reste identique à une utilisation standard d'OpenAI. Cela garantit une migration facile pour les projets existants. Vous pouvez ajuster des paramètres comme la température et le top_p directement dans l'appel.

Copyfrom openai import OpenAI

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

Gérez les exceptions pour les limites de débit ou les clés invalides. La bibliothèque diffuse les tokens si vous définissez stream sur true. Cette approche garde votre base de code propre et compatible.

Installation du SDK Node.js

Utilisez le openai paquet npm. Initialisez le client avec l'URL de base personnalisée. Transmettez votre clé API. La syntaxe imite l'exemple Python. Cette cohérence réduit le temps de débogage. Vous pouvez envoyer plusieurs messages dans un tableau d'historique de conversation.

Copyimport OpenAI from "openai";

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

Analysez la réponse avec soin. L'API retourne du JSON structuré. La gestion des erreurs est cruciale pour les applications de production. Capturez les erreurs réseau et les erreurs spécifiques à l'API séparément. Cela garantit que votre application reste réactive lors des pics de trafic.

Mode JSON et streaming

Activez le streaming en définissant le stream parameter à true. L'API envoie des jetons via Server-Sent Events. Vous recevez des réponses partielles en temps réel. Cela améliore l'expérience utilisateur pour les sorties longues. Vous pouvez également imposer une sortie JSON en utilisant response_format. C'est utile pour l'extraction de données structurées.

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)

L'appel de fonctions fonctionne de manière similaire. Définissez des outils dans votre requête. Le modèle renvoie des appels d'outils. Analysez ces appels dans votre code. Exécutez-les et renvoyez les résultats au modèle. Cette boucle permet des workflows complexes.

Limites, Erreurs et Contexte

La fenêtre de contexte est de 100 000 tokens. La sortie maximale est de 16 000 tokens par requête. Les erreurs incluent 401 pour les clés invalides et 402 pour le crédit insuffisant. Les limites de taux sont plafonnées à 300 requêtes par minute. Gérez-les gracieusement dans votre application. L'API n'utilise jamais vos invites pour l'entraînement. La confidentialité est préservée. Le crédit n'expire pas.