Aller au contenu

Ressource de modèle

Ce guide fournit des informations détaillées sur l'interaction avec notre API pour gérer et utiliser les ressources d'arrière-plan de vos modèles.

Téléchargement des ressources d'arrière-plan

Ce point de terminaison vous permet de télécharger des images ou des vidéos d'arrière-plan qui pourront être utilisées ultérieurement lors de la création de modèles pour vos projets de génération vidéo. N'oubliez pas de définir l'en-tête « Content-Type » sur « multipart/form-data » lors de cette requête.

Exemple de requête

Voici un exemple de téléchargement d'image avec curl :

curl --request POST \
     --url 'https://api.immersive-fox.com/v1/template/background_asset_upload/' \
     --header 'X-Api-Key: <your-api-key>' \
     --header 'Content-Type: multipart/form-data' \
     --form 'type=image' \
     --form 'image=@/path/to/your/image.jpg' \
     --form 'thumbnail=@/path/to/your/thumbnail.jpg'

{
    "id": 123,
    "image": "https://url/to/your/image.jpg",
    "thumbnail": "https://url/to/your/thumbnail.jpg"
}

Pour télécharger une vidéo, utilisez plutôt « type=video » et « video=@/path/to/your/video.mp4 ».

Remarques :

  • Le champ « type » doit être « image » ou « video », selon le type de ressource téléchargée.
  • Lors du téléchargement d'une image, vous devez également fournir une miniature dans le champ « thumbnail ».
  • Les ressources téléchargées peuvent être référencées lors de la création de modèles pour la génération de vidéos.

Liste des ressources d'arrière-plan :

Ce point de terminaison vous permet de lister les images et vidéos d'arrière-plan téléchargées comme ressources. Vous pouvez filtrer les résultats en spécifiant le type de ressource qui vous intéresse. Assurez-vous d'inclure le paramètre de requête « type » dans votre requête, qui peut être « image » ou « video ». Vous pouvez également spécifier « color » pour lister les couleurs par défaut pouvant être utilisées comme arrière-plan.

Exemple de requête :

Voici un exemple de liste de ressources d'arrière-plan avec curl :

curl --request GET \
     --url 'https://api.immersive-fox.com/v1/template/background_assets/?type=image' \
     --header 'X-Api-Key: <your-api-key>'

[
    {
        "id": 123,
        "image": "https://url/to/your/image.jpg",
        "thumbnail": "https://url/to/your/thumbnail.jpg"
    },
    {
        "id": 124,
        "image": "https://url/to/another/image.jpg",
        "thumbnail": "https://url/to/another/thumbnail.jpg"
    }
]