Saltar a contenido

Recurso de plantilla

Esta guía proporciona información detallada sobre cómo interactuar con nuestra API para administrar y utilizar recursos de fondo en sus plantillas.

Subir recursos de fondo.

Este punto final le permite subir imágenes o vídeos de fondo que podrá usar más adelante al crear plantillas para sus proyectos de generación de vídeos. Recuerde configurar el encabezado Content-Type como multipart/form-data al realizar esta solicitud.

Ejemplo de solicitud.

Aquí tiene un ejemplo de cómo subir una imagen con 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"
}

Para subir un video, usarías type=video y video=@/path/to/your/video.mp4 en su lugar.

Notas:

  • El campo type debe ser "image" o "video", dependiendo del tipo de activo que estés subiendo.
  • Al subir una imagen, también debes proporcionar una imagen en miniatura en el campo thumbnail.
  • Los activos subidos pueden ser referenciados al crear plantillas para la generación de videos.

Listado de activos de fondo

Este punto final te permite listar imágenes y videos de fondo que han sido subidos como activos. Puedes filtrar los resultados especificando el tipo de activo que te interesa. Asegúrate de incluir el parámetro de consulta type en tu solicitud, que puede ser "image" o "video". También puedes especificar "color" para listar los colores predeterminados que pueden usarse como fondo.

Solicitud de ejemplo

Aquí hay un ejemplo de cómo listar activos de fondo usando curl: === "Solicitud"

```bash
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"
    }
]