Guide
Vue d'ensemble des interfaces
Toutes les interfaces publiques, les méthodes d'authentification et la documentation détaillée correspondante
Vue d'ensemble des interfaces
L'adresse de base est uniformément https://locopalai.com, et toutes les interfaces utilisent la même clé API de plateforme. Les conventions communes (authentification, structure de réponse, pagination, limitation de débit, idempotence) sont décrites dans Authentification et conventions de base.
Interfaces de modèles et de génération
| Usage | Méthode | Chemin | Documentation détaillée |
|---|---|---|---|
| Interroger les modèles disponibles | GET | /v1/models | Interfaces de modèles et de texte |
| Conversation textuelle (avec streaming) | POST | /v1/chat/completions | Interfaces de modèles et de texte |
| Génération d'images | POST | /v1/images/generations | Interface de génération d'images |
| Synthèse vocale | POST | /v1/audio/speech | Interface de synthèse vocale |
| Créer une tâche vidéo | POST | /v1/video/generations | Interface de génération vidéo |
| Interroger une tâche vidéo | GET | /v1/video/generations/{task_id} | Interface de génération vidéo |
| Créer une tâche vidéo (syntaxe compatible OpenAI) | POST | /v1/videos | Interface de génération vidéo |
| Interroger une tâche vidéo (syntaxe compatible OpenAI) | GET | /v1/videos/{task_id} | Interface de génération vidéo |
Interfaces de la bibliothèque de ressources
Toutes les interfaces de la bibliothèque de ressources utilisent une clé API et renvoient uniformément en cas de succès { "code": 0, "data": ..., "msg": "..." }.
| Usage | Méthode | Chemin | Documentation détaillée |
|---|---|---|---|
| Interroger les groupes de ressources | GET | /api/v1/materials/groups | Groupes de ressources |
Créer un groupe de ressources (virtual / real) | POST | /api/v1/materials/groups | Groupes de ressources |
Interroger la liste des ressources (prise en charge de group_id et de la pagination) | GET | /api/v1/materials/assets | Ressources |
Soumettre une ressource image (image_url ou data_url) | POST | /api/v1/materials/assets | Ressources |
| Interroger le statut d'une ressource | GET | /api/v1/materials/assets/{asset_id} | Ressources |
| Synchroniser le statut des ressources | POST | /api/v1/materials/sync | Synchroniser le statut des ressources |
| Créer une session d'autorisation de portrait par scan de code QR | POST | /api/v1/materials/portrait/sessions | Autorisation de ressources de portrait |
| Confirmer la fin du scan de code QR du portrait | POST | /api/v1/materials/portrait/resolve | Autorisation de ressources de portrait |
Pour les paramètres détaillés, les exemples et les descriptions d'erreurs, voir Vue d'ensemble des interfaces de la bibliothèque de ressources.
Chaîne d'appels typique
Modèles et vidéo
GET /v1/models
→ POST /v1/video/generations
→ GET /v1/video/generations/{task_id}Après avoir créé une tâche, vous devez enregistrer l'ID de la tâche ; en cas d'interruption réseau, continuez à interroger la tâche d'origine au lieu de la recréer.
Synthèse vocale
GET /v1/models
→ POST /v1/audio/speech
→ 保存二进制音频响应La disponibilité de l'interface audio, ainsi que les valeurs de voice et de response_format prises en charge, dépendent du catalogue de modèles de la clé actuelle et des capacités réelles du modèle.
Ressources virtuelles
POST /api/v1/materials/groups
→ POST /api/v1/materials/assets
→ GET /api/v1/materials/assets/{asset_id} (轮询到 status 为 Active)
→ 在视频 content 中使用 asset://<asset_id>Ressources de portrait
POST /api/v1/materials/groups {"type":"real"}
→ POST /api/v1/materials/portrait/sessions (拿到二维码链接)
→ 由真人本人扫码完成采集
→ POST /api/v1/materials/portrait/resolve
→ POST /api/v1/materials/sync
→ 查询素材状态后用于支持真人素材库的模型Pour un exemple de bout en bout, voir Flux d'intégration des ressources de portrait et des vidéos de référence ; pour les limites de capacité des images multiples et des vidéos de référence, voir Description des images multiples et des vidéos de référence.
Réponses et erreurs
| Type d'interface | Succès | Échec |
|---|---|---|
| Modèle / Image / Vidéo | Renvoie directement l'objet de résultat | HTTP non 2xx, lisez error.message |
| Bibliothèque de ressources | { "code": 0, "data": ..., "msg": "OK" } | Le code de statut HTTP correspond à code |
Le client doit toujours vérifier à la fois le statut HTTP et le corps de la réponse. Pour la liste complète des codes d'erreur et les méthodes de diagnostic, voir Codes d'erreur et diagnostic.
Authentification et conventions de base
Adresse de base, authentification par clé API, conventions de requête et de réponse, pagination, limitation de débit, idempotence et gestion des erreurs
Interfaces de modèles et de texte
Conventions de requête et de réponse pour la consultation des modèles disponibles et la conversation textuelle (y compris en streaming)
