Ir para o conteúdo

Recurso de modelo

Este guia fornece informações detalhadas sobre como interagir com nossa API para gerenciar e utilizar ativos de segundo plano para seus modelos.

Carregando ativos de segundo plano

Este ponto de extremidade permite que você carregue imagens de fundo ou vídeos que podem ser usados posteriormente ao criar modelos para seus projetos de geração de vídeo. Lembre-se de definir o cabeçalho Content-Type como multipart/form-data ao fazer esta solicitação.

Exemplo de solicitação

Aqui está um exemplo de como carregar uma imagem usando 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 carregar um vídeo, você usaria type=video e video=@/path/to/your/video.mp4.

Observações

  • O campo type deve ser "image" ou "video", dependendo do tipo de ativo que você está carregando.
  • Ao carregar uma imagem, você também deve fornecer uma imagem em miniatura no campo thumbnail.
  • Os ativos carregados podem ser referenciados ao criar modelos para geração de vídeo.

Listando ativos de fundo

Este ponto de extremidade permite que você liste imagens de fundo e vídeos que foram carregados como ativos. Você pode filtrar os resultados especificando o tipo de ativo no qual está interessado. Certifique-se de incluir o parâmetro de consulta type em sua solicitação, que pode ser "image", "video". Você também pode especificar "color" para listar as cores padrão que podem ser usadas como um fundo.

Exemplo de solicitação

Aqui está um exemplo de como listar ativos de fundo usando 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"
    }
]