Guide
Groupes de ressources
Description des interfaces de création et d'interrogation des groupes de ressources
Groupes de ressources
Le groupe de ressources est le conteneur des ressources. Avant de soumettre une image, il faut d'abord disposer d'un groupe de ressources virtuelles.
Créer un groupe de ressources
/api/v1/materials/groupsMéthode d'authentification
Authorization: Bearer <API_KEY>, en utilisant la clé API de plateforme créée dans « Clés API » de la console.
Corps de la requête · application/json
Prop
Type
Un groupe de même nom et de même type n'est pas créé en double sous le même compte ; un appel répété renvoie directement le groupe existant.
Exemple de requête
curl -X POST "$LOCOPAL_BASE_URL/api/v1/materials/groups" \
-H "Authorization: Bearer $LOCOPAL_API_KEY" \
-H "Content-Type: application/json" \
--data-binary @- <<'JSON'
{
"name": "品牌虚拟角色",
"description": "电商视频人物设定图",
"type": "virtual"
}
JSONPour créer un groupe de portrait, utilisez la même interface en remplaçant seulement type par real :
curl -X POST "$LOCOPAL_BASE_URL/api/v1/materials/groups" \
-H "Authorization: Bearer $LOCOPAL_API_KEY" \
-H "Content-Type: application/json" \
--data-binary @- <<'JSON'
{
"name": "真人素材库",
"description": "已完成授权的真人素材",
"type": "real"
}
JSONParamètres de réponse
| Paramètre | Type | Description |
|---|---|---|
code | integer | 0 en cas de succès |
msg | string | 素材分组已创建 en cas de succès |
data.group.id | string | ID du groupe utilisé par le compte actuel, à utiliser comme group_id lors de la soumission ultérieure de ressources |
data.group.platform_group_id | string | ID de groupe de la plateforme du service de ressources, utilisé pour le diagnostic ; dans le déploiement actuel, il est généralement identique à id |
data.group.name | string | Nom du groupe |
data.group.type | string | virtual ou real |
data.group.description | string / null | Description du groupe, null si elle n'est pas renseignée |
data.group.created_at | integer | Date de création (secondes Unix) |
data.group.updated_at | integer | Date de mise à jour (secondes Unix) |
Corps de la réponse
{
"code": 0,
"data": {
"group": {
"id": "group-1789069780-5762d1",
"platform_group_id": "group-1789069780-5762d1",
"name": "品牌虚拟角色",
"type": "virtual",
"description": "电商视频人物设定图",
"created_at": 1789069780,
"updated_at": 1789069780
}
},
"msg": "素材分组已创建"
}Réponses d'erreur
| HTTP | msg | Description |
|---|---|---|
400 | 请求体必须是 JSON 对象 | Le corps de la requête n'est pas un JSON valide |
400 | type 只能是 virtual 或 real | Valeur de type incorrecte |
400 | 素材分组名称不能为空 | name manquant |
400 | 素材分组名称不能超过 64 个字符 | name trop long |
400 | 素材分组说明不能超过 300 个字符 | description trop longue |
401 | Invalid token | Clé API absente, erronée ou expirée |
502 / 503 | 素材服务暂不可用 | Service de ressources anormal ; conservez les informations de requête et réessayez |
Interroger les groupes de ressources
/api/v1/materials/groupsMéthode d'authentification
Authorization: Bearer <API_KEY>. Les requêtes GET doivent également la comporter.
Paramètres de la requête · query
| Paramètre | Type | Obligatoire | Valeur par défaut | Description |
|---|---|---|---|---|
page | integer | Non | 1 | Numéro de page ; une valeur inférieure à 1 est traitée comme 1 |
page_size | integer | Non | 20 | Nombre d'éléments par page, 100 maximum ; une valeur hors plage est traitée comme 20 |
Exemple de requête
curl "$LOCOPAL_BASE_URL/api/v1/materials/groups?page=1&page_size=20" \
-H "Authorization: Bearer $LOCOPAL_API_KEY"Paramètres de réponse
| Paramètre | Type | Description |
|---|---|---|
code | integer | 0 en cas de succès |
msg | string | OK en cas de succès |
data.total | integer | Nombre total de groupes du compte actuel |
data.page | integer | Numéro de page de cette requête |
data.page_size | integer | Nombre d'éléments par page de cette requête |
data.groups | array | Liste des groupes, champs identiques à l'interface de création ; ne contient que les groupes propres au compte actuel |
Corps de la réponse
{
"code": 0,
"data": {
"groups": [
{
"id": "group-1789069780-5762d1",
"platform_group_id": "group-1789069780-5762d1",
"name": "品牌虚拟角色",
"type": "virtual",
"description": "电商视频人物设定图",
"created_at": 1789069780,
"updated_at": 1789069780
}
],
"total": 1,
"page": 1,
"page_size": 20
},
"msg": "OK"
}Réponses d'erreur
| HTTP | msg | Description |
|---|---|---|
401 | Invalid token | Clé API absente, erronée ou expirée |
500 / 502 / 503 | 素材服务暂不可用 | Service de ressources anormal ; conservez les informations de requête et réessayez |
Vue d'ensemble des interfaces de la bibliothèque de ressources
Réponse unifiée, pagination, ID de ressource et correspondance entre modèles et bibliothèque de ressources des interfaces de la bibliothèque de ressources
Ressources
Soumettre des ressources image, interroger le statut de validation et interroger la liste des ressources