Résumé de la spécification
Si vous avez déjà du code qui communique avec OpenAI, la version courte de la spécification API compatible OpenAI est celle-ci : changez l'URL de base, changez la clé, définissez le modèle sur uncensored. Les corps de requête et de réponse suivent la structure des complétions de chat, donc les SDK les analysent sans modifications.
| Élément | Valeur |
|---|---|
| URL de base | https://api.unrestrictedaiapi.com/v1 |
| Authentification | Authorization: Bearer YOUR_KEY |
| Méthodes | POST /v1/chat/completions, GET /v1/models |
| ID du modèle | uncensored |
| Fenêtre de contexte | 100 000 tokens, prompt plus complétion |
| Taille maximale du corps de la requête | 8 Mo |
| Sortie | Texte uniquement |
Le modèle est un modèle à poids ouverts unique exécuté par un fournisseur indépendant et ajusté pour répondre sans refus de contenu pour une utilisation adulte légale. Ce n'est pas l'endpoint officiel d'aucun fournisseur de modèle et il ne fait pas de routage entre les fournisseurs. C'est pourquoi il n'y a qu'un seul ID de modèle et pourquoi la liste des modèles est courte.
Méthodes
GET /v1/models
Renvoie les modèles disponibles pour votre clé. C'est le moyen le moins cher de confirmer que votre clé et votre URL de base sont corrects, et de nombreux clients UI l'appellent pour remplir une liste déroulante.
curl https://api.unrestrictedaiapi.com/v1/models \
-H "Authorization: Bearer $KEY"
POST /v1/chat/completions
Le seul endpoint de génération. Vous envoyez un tableau messages d'objets avec un role (system, user, assistant ou tool) et content, plus le modèle et toute option d'échantillonnage. Un appel minimal :
curl https://api.unrestrictedaiapi.com/v1/chat/completions \
-H "Authorization: Bearer $KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [
{"role": "system", "content": "Answer in one sentence."},
{"role": "user", "content": "What is a base URL?"}
]
}'
La réponse contient le texte généré dans choices[0].message.content et les nombres de tokens dans usage. Ces nombres sont la base de la facturation.
Non offert : l'endpoint legacy completions, les embeddings, les endpoints image, audio et vidéo, le fine-tuning et les endpoints de fichiers. Un client qui les appelle recevra une erreur, donc désactivez ces fonctionnalités dans les outils qui les utilisent par défaut.
Paramètres de la requête
Ces paramètres sont acceptés et transmis au modèle :
temperatureettop_ppour l'échantillonnage.stoppour une ou plusieurs séquences d'arrêt.seedpour un échantillonnage reproductible lorsque vous gardez tout le reste identique.presence_penaltyetfrequency_penaltypour réduire la répétition.max_tokens, qui est optionnel. Si vous l'omettez, la complétion peut utiliser le reste de la fenêtre de 100 000 tokens.streampour les événements envoyés par le serveur.toolsettool_choicepour l'appel de fonctions.response_formatavec{"type":"json_object"}pour le mode JSON.
Deux notes pratiques. Premièrement, la fenêtre compte le prompt et la complétion ensemble, donc un prompt de 90 000 tokens laisse environ 10 000 tokens pour la réponse. Deuxièmement, la limite de corps est de 8 Mo, ce qui est bien plus que ce dont 100 000 tokens de texte ont besoin, donc vous n'atteignez cette limite qu'en intégrant de gros payloads encodés dans les messages.
Diffusion en continu
Définissez stream: true et la réponse arrive sous forme d'événements envoyés par le serveur. Chaque événement est un fragment JSON avec un delta contenant la prochaine partie de texte, et l'utilisation est signalée à la fin du flux. Les SDK masquent le formatage ; avec le protocole brut, vous lisez les lignes qui commencent par data: jusqu'à la fermeture du flux.
from openai import OpenAI
client = OpenAI(base_url="https://api.unrestrictedaiapi.com/v1", api_key="YOUR_KEY")
with client.chat.completions.create(
model="uncensored",
messages=[{"role": "user", "content": "List five HTTP status codes."}],
stream=True,
) as stream:
for chunk in stream:
if chunk.choices and chunk.choices[0].delta.content:
print(chunk.choices[0].delta.content, end="")
Une règle affecte la planification de la capacité : une requête en streaming occupe son slot de concurrence jusqu'à la fin du flux, pas jusqu'au premier token. Si un client bloque pendant la lecture, il garde le slot occupé. Fermez ou terminez toujours le flux, et définissez un délai d'attente client.
Appel de fonctions et mode JSON
Appel de fonctions
Passez tools en tant que liste de définitions de fonctions avec des paramètres JSON Schema. Si le modèle décide d'appeler l'une d'elles, le message contient tool_calls, qui sont également streamés lorsque stream est activé. Vous exécutez la fonction et renvoyez son résultat en tant que message avec role: "tool" et l'tool_call_id correspondant. Utilisez tool_choice pour forcer une fonction particulière ou laisser la décision au modèle.
{
"model": "uncensored",
"messages": [{"role": "user", "content": "Weather in Oslo?"}],
"tools": [{
"type": "function",
"function": {
"name": "get_weather",
"description": "Current weather for a city",
"parameters": {
"type": "object",
"properties": {"city": {"type": "string"}},
"required": ["city"]
}
}
}]
}
Le modèle propose des arguments ; il n'exécute rien. Validez-les avant d'agir dessus, comme vous le feriez avec n'importe quelle entrée utilisateur.
Mode JSON
Ajoutez "response_format": {"type": "json_object"} pour demander un seul objet JSON valide. Comme pour les autres implémentations de style OpenAI, indiquez également au modèle dans le prompt quelles clés vous souhaitez, par exemple "Renvoyez un objet avec les clés title et tags". Analysez toujours le résultat dans un bloc try, et gardez max_tokens généreux pour qu'un objet long ne soit pas coupé.
Limites, en-têtes et erreurs
| Type de clé | Requêtes simultanées | Requêtes par minute |
|---|---|---|
| Clé complète | 8 | 300 |
| Clé d'essai | 2 | 60 |
Chaque réponse inclut X-Request-Id (citez-le lorsque vous contactez support), X-Balance-USD (votre crédit restant), X-RateLimit-Limit-Requests et X-RateLimit-Limit-Concurrency.
Lorsque vous dépassez une limite, l'API renvoie HTTP 429. Le code d'erreur sépare les cas :
rate_limited: trop de requêtes en une minute. Ralentissez ou répartissez la charge.concurrency: trop de requêtes en vol à la fois. Mettez-les en file d'attente de votre côté.- 429 avec un en-tête
Retry-After: 5: surcharge temporaire. Attendez cinq secondes et réessayez.
import time
import httpx
def post_with_retry(payload, key, tries=4):
# payload example: {"model": "uncensored", "messages": [...]}
for attempt in range(tries):
r = httpx.post(
"https://api.unrestrictedaiapi.com/v1/chat/completions",
headers={"Authorization": "Bearer " + key},
json=payload,
timeout=120,
)
if r.status_code == 429:
wait = int(r.headers.get("Retry-After", 2 ** attempt))
time.sleep(wait)
continue
return r
return r
Les requêtes qui échouent ou sont refusées ne sont pas facturées.
Rôles, historique et objet de réponse
L'API est sans état. Elle ne se souvient pas des requêtes précédentes, donc une conversation n'existe que sous forme de tableau messages que vous envoyez à chaque fois. Un historique typique commence par un message system qui définit le comportement, suivi de messages alternés user et assistant. Lorsque l'appel de fonctions est en jeu, des messages tool apparaissent entre eux, chacun lié à l'appel auquel il répond par tool_call_id.
Cela a deux conséquences. La première est le coût : chaque tour paie pour tout l'historique en entrée, donc une longue conversation devient plus coûteuse par message même si chaque question est courte. La seconde est le contrôle : vous pouvez modifier, réduire ou réécrire l'historique à volonté. Supprimer les tours les plus anciens, les remplacer par un résumé ou injecter un message assistant corrigé sont des opérations ordinaires, et le modèle traite ce que vous envoyez comme la vérité.
De retour, lisez trois éléments. choices[0].message contient le texte ou les appels de fonctions. choices[0].finish_reason vous indique pourquoi la génération s'est arrêtée : une fin naturelle, la limite de tokens ou un appel de fonction. usage contient les comptages de tokens de prompt, de complétion et totaux. Si la raison d'arrêt indique que la limite de tokens a été atteinte, le texte est tronqué, et vous devriez soit augmenter la limite, soit demander au modèle de continuer dans un tour suivant.
Une courte liste de vérification de compatibilité
Avant de déployer un client sur cet endpoint, passez en revue ces vérifications. Elles détectent la plupart des problèmes d'intégration en quelques minutes.
- Appelez
GET /v1/modelsavec votre clé et confirmez que vous obtenez une liste qui inclutuncensored. - Envoyez une requête de chat simple sans options et confirmez une réponse normale avec un bloc
usage. - Répétez-le avec
stream: trueet confirmez que votre client gère la fin du flux et les données d'utilisation finales. - Si vous utilisez des outils, envoyez un aller-retour d'appel d'outil de bout en bout, y compris la requête de suivi avec le message
tool. - Lancez 10 requêtes simultanément sur une clé d'essai et confirmez que votre code gère le 429 qui suit la deuxième requête concurrente.
- Journalisez
X-Request-Idpour chaque appel afin que tout résultat étrange puisse être retracé plus tard.
Réussir les six signifie que votre client est prêt pour le trafic réel.
En quoi cela diffère de la plateforme OpenAI complète
La compatibilité signifie le protocole de chat, pas toute la plateforme. Tout ce qui est en dehors du chat textuel est absent, et certains comportements proviennent du modèle plutôt que du protocole. Le nom du modèle est fixe, les réponses peuvent différer en style de celles de tout modèle que vous avez utilisé auparavant, et l'échantillonnage avec le même seed n'est répétable que tant que le prompt et les paramètres restent identiques.
La seule règle de contenu que vous ne pouvez pas modifier est que le contenu sexuel impliquant des mineurs est bloqué. Au-delà de cela, le modèle est ajusté pour éviter les refus pour une utilisation légale des adultes, et les prompts ne sont pas utilisés pour l’entraînement.
Pour le code dans cinq langues, consultez le démarrage rapide, pour les techniques de prompt, lisez formuler des prompts pour un modèle sans restrictions, et pour la gestion du compte, tarifs liste les tarifs : 0,15 $ par 1M de tokens d’entrée et 0,50 $ par 1M de tokens de sortie, avec un crédit qui n’expire jamais. La documentation contient la même spécification sous forme abrégée.
