Documentation API

Démarrage rapide : Votre première requête

Envoyez votre premier message au modèle uncensored immédiatement. Utilisez le point de terminaison standard de chat-completions pour générer du texte. Le modèle répond aux invites en langage naturel sans refus de contenu pour un usage adulte légal. Cette configuration fonctionne avec n'importe quel client compatible OpenAI.

Commencez par installer le SDK pour votre langage préféré. Ensuite, configurez votre clé API. L'exemple suivant montre une requête curl de base pour tester la connectivité.

Vous pouvez ajuster des paramètres tels que temperature pour contrôler l'aléatoire. La réponse retourne le texte généré directement. Ce flux simple vous permet de vérifier que l'API fonctionne avant de construire une logique complexe.

Copycurl https://api.apiaicharacter.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "What is the current API rate limit status?"}]
  }'

URL de base et authentification

Connectez-vous en utilisant l'URL de base dédiée à cette API. Remplacez le point de terminaison par défaut par l'adresse de notre serveur hébergé. Cela garantit que vos requêtes atteignent directement le modèle sans censure. L'authentification repose sur une seule clé API par compte.

Générez votre clé via le tableau de bord. Transmettez-la dans l'en-tête Authorization en tant que jeton Bearer. Cette méthode est compatible avec les SDK OpenAI standard. Vous pouvez changer de fournisseur en modifiant uniquement l'URL de base et la clé.

Conservez votre clé en sécurité. Elle donne un accès complet à votre crédit prépayé. La clé remplace toute clé active précédente immédiatement après sa génération.

Points de terminaison : Chat Completions

Interagissez avec le modèle via le point de terminaison des complétions de chat. C'est le seul point de terminaison de génération de texte disponible. Il accepte des messages et renvoie du texte généré. Les embeddings, les images et l'audio ne sont pas pris en charge.

Envoyez une requête POST au chemin de chat. Incluez vos messages système et utilisateur dans le corps. Le modèle traite le contexte et génère une réponse. Vous pouvez utiliser le mode JSON pour une sortie structurée.

L'appel de fonctions est également pris en charge. Définissez des outils et laissez le modèle décider quand les utiliser. Cette flexibilité permet des workflows d'agents complexes. La réponse inclut le contenu généré et l'utilisation des tokens.

Copyfrom openai import OpenAI

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

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

Contrôlez le style de sortie à l’aide de paramètres standards. Ajustez la température pour modifier la créativité. Des valeurs plus basses rendent les réponses plus déterministes. Des valeurs plus élevées introduisent plus de variété.

Utilisez top_p pour filtrer les mots peu probables. Cela aide à maintenir la cohérence tout en permettant la créativité. Définissez les séquences d'arrêt pour terminer la génération à des marqueurs spécifiques. Cela est utile pour contrôler la structure du dialogue.

Le paramètre seed permet d'obtenir des résultats reproductibles. Utilisez-le lors du débogage de vos prompts. Ces paramètres vous offrent un contrôle précis sur le comportement du modèle. Ajustez-les pour les adapter aux besoins de votre application.

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.apiaicharacter.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 et utilisation des jetons

Recevez des réponses en temps réel via les server-sent events. Le streaming réduit la latence perçue pour les utilisateurs. L'API envoie les jetons au fur et à mesure de leur génération. Cela crée une expérience de lecture plus fluide.

L'utilisation de tokens est rapportée dans le dernier chunk. Cela vous permet de suivre les coûts avec précision. La facturation est basée sur les tokens réellement consommés. Les erreurs et les refus ne génèrent pas de frais.

Mettez en œuvre un gestionnaire de flux pour traiter les données. Mettez à jour votre interface utilisateur à mesure que les jetons arrivent. Cette approche est idéale pour les interfaces de chat. Le modèle prend en charge le streaming pour tous les types de requêtes.

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)

Limites de débit et contraintes

Comprendre les limites pour éviter les interruptions de service. Vous pouvez effectuer 300 requêtes par minute par clé. Les requêtes simultanées sont limitées à huit en même temps. Le corps de la requête ne doit pas dépasser 8 Mo.

Gérez les erreurs avec élégance. Un statut 401 signifie que votre clé est invalide. Un statut 402 indique un crédit insuffisant. Un statut 429 signale que vous avez atteint la limite de taux.

La fenêtre de contexte prend en charge 100 000 tokens au total. Cela inclut à la fois l'invite et la complétion. Le maximum de sortie est de 16 000 tokens par requête. Définissez max_tokens pour contrôler la longueur de la sortie. Les erreurs sont gratuites, la logique de nouvelle tentative est donc sûre.