Intégration d'outils courants

Un client prenant en charge une adresse personnalisée compatible OpenAI ne nécessite généralement que la configuration de la Base URL, de l'API Key et de l'ID de modèle. Le catalogue de modèles fait foi selon le résultat en temps réel de /v1/models.

Les clients compatibles OpenAI couvrent les interfaces de catalogue de modèles, de conversation texte, de génération d'images, de tâches vidéo et de synthèse vocale ; l'interface de la bibliothèque de ressources utilise le chemin propre à la plateforme /api/v1/materials/.... Lancez directement des requêtes HTTP selon l'interface de la bibliothèque de ressources ; le client ne prend pas en charge cette partie.

Configuration générale

Si l'outil demande une URL complète, utilisez https://locopalai.com/v1/chat/completions ; s'il demande une Base URL, indiquez simplement jusqu'à /v1.

La plateforme peut également afficher des adresses telles que https://us-api.locopalai.com, destinées aux modèles étrangers ou à des environnements réseau spécifiques. Lors de l'intégration, utilisez l'adresse actuellement affichée par la console ; n'indiquez pas les deux domaines à la fois dans la configuration d'un même client.

OpenAI JavaScript SDK

npm install openai

import OpenAI from 'openai'

const client = new OpenAI({
  apiKey: process.env.LOCOPAL_API_KEY,
  baseURL: 'https://locopalai.com/v1',
})

const models = await client.models.list()
const result = await client.chat.completions.create({
  model: models.data[0].id,
  messages: [{ role: 'user', content: '你好' }],
})
console.log(result.choices[0].message.content)

OpenAI Python SDK

pip install openai

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["LOCOPAL_API_KEY"],
    base_url="https://locopalai.com/v1",
)
models = client.models.list()
response = client.chat.completions.create(
    model=models.data[0].id,
    messages=[{"role": "user", "content": "你好"}],
)
print(response.choices[0].message.content)

Cherry Studio

1. Ouvrez les paramètres du service de modèles et ajoutez un service compatible OpenAI.
2. Dans le champ d'adresse API, saisissez https://locopalai.com/v1.
3. Dans le champ API Key, saisissez la clé créée dans la console.
4. Cliquez sur récupérer les modèles, ou renseignez manuellement l'ID de modèle renvoyé par /v1/models.
5. Après l'enregistrement, créez une conversation pour vérifier.

Si la liste des modèles est vide, vérifiez d'abord /v1/models avec la même clé via curl ; si curl fonctionne, vérifiez si le client ajoute /v1 en double.

OpenCode

Configurez un Provider compatible OpenAI dans opencode.json au niveau utilisateur ou au niveau du projet :

{
  "$schema": "https://opencode.ai/config.json",
  "provider": {
    "locopal": {
      "npm": "@ai-sdk/openai-compatible",
      "name": "LocoPal Ai",
      "options": {
        "baseURL": "https://locopalai.com/v1",
        "apiKey": "{env:LOCOPAL_API_KEY}"
      },
      "models": {
        "你的模型ID": { "name": "你的模型ID" }
      }
    }
  },
  "model": "locopal/你的模型ID"
}

La syntaxe de configuration peut varier selon la version du client ; reportez-vous aux spécifications de configuration du client actuel. L'essentiel est que la Base URL, l'API Key et l'ID de modèle concordent.

Trae et autres IDE

Dans « Paramètres → Modèles → Ajouter un modèle », choisissez le format compatible OpenAI :

1. Si « URL complète » est désactivé, saisissez https://locopalai.com/v1.
2. Si « URL complète » est activé, saisissez https://locopalai.com/v1/chat/completions.
3. Saisissez l'API Key.
4. Saisissez l'ID du modèle actuellement disponible.
5. Activez les options de vision ou d'appel d'outils selon les capacités réelles du modèle.

Postman / Apifox

Créez trois variables d'environnement : base_url=https://locopalai.com, api_key=你的APIKey et model=从 /v1/models 获取的模型 ID. Ajoutez à chaque requête :

Authorization: Bearer {{api_key}}
Content-Type: application/json

Pour les tâches vidéo, conservez d'abord l'ID de la réponse de création, puis utilisez GET pour interroger {{base_url}}/v1/video/generations/{{task_id}}.

Recommandations pour un proxy côté serveur

Les navigateurs et applications mobiles ne doivent pas détenir directement l'API Key de la plateforme. L'architecture recommandée est « page web ou App → votre backend métier → LocoPal Ai ». Le backend métier assure l'authentification des utilisateurs, la validation des paramètres, la journalisation des requêtes, la persistance des ID de tâche, le contrôle des quotas et la copie des résultats.

Auto-vérification de l'intégration

1. GET /v1/models renvoie au moins un modèle.
2. Un appel texte renvoie choices.
3. La création vidéo renvoie un ID de tâche.
4. La consultation vidéo renvoie un statut et ne recrée pas la tâche.
5. Si le groupe actuel fournit un modèle de synthèse vocale, POST /v1/audio/speech renvoie un flux audio binaire lisible.
6. En cas de 401, vérifiez la clé ; en cas de 429, attendez selon le message ; en cas de 5xx, conservez le RequestId avant de déterminer si un nouvel essai est possible.