Skip to main content

Referência da API PixVerse - vídeo com referência

O modelo de vídeo com referência PixVerse aceita várias imagens de referência. Ele usa um prompt de texto para descrever a cena e combina os personagens dos recursos em um vídeo fluido.

Este documento se aplica somente à região de Singapura. Use uma chave de API dessa região.

Ativar o serviço

  1. Acesse o console do Model Studio, pesquise por PixVerse, encontre o cartão do modelo PixVerse e clique em Activate Now.
  2. Na janela pop-up, confirme a ativação e a autorização.

Notas de uso

Para que as chamadas de API sejam bem-sucedidas, use um modelo, uma URL de endpoint e uma chave de API da mesma região. Chamadas entre regiões falharão.
O código de exemplo deste tópico se aplica à região de Singapura.

Chamadas HTTP

A geração de vídeo com referência costuma levar de 1 a 5 minutos, por isso a API usa chamadas assíncronas. O fluxo tem duas etapas principais: "Criar uma tarefa -> Consultar periodicamente o resultado". As etapas são as seguintes:

Etapa 1: criar uma tarefa para obter o ID da tarefa

Região de Singapura: POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/video-generation/video-synthesis Substitua {WorkspaceId} pelo seu ID do workspace real.
  • Após criar a tarefa, use o task_id retornado para consultar o resultado. O task_id é válido por 24 horas. Não crie tarefas duplicadas. Consulte periodicamente o resultado.
  • Para orientações iniciais, consulte Chamar APIs com Postman ou cURL.

Parâmetros de solicitação

Cabeçalhos
Content-Type string (Obrigatório)O tipo de conteúdo da solicitação. Deve ser application/json.Authorization string (Obrigatório)Autentica a solicitação com uma chave de API do Model Studio. Exemplo: Bearer sk-xxxx.X-DashScope-Async string (Obrigatório)Ativa o processamento assíncrono. As solicitações HTTP permitem apenas chamadas assíncronas. Deve ser enable.
Se esse cabeçalho de solicitação estiver ausente, será retornado o erro "current user api does not support synchronous calls".
Corpo da solicitação
model string (Obrigatório)O nome do modelo. Para as especificações de saída dos modelos, consulte a Lista de modelos.Valores válidos:
  • pixverse/pixverse-v6-r2v
input object (Obrigatório)As informações básicas de entrada, incluindo as imagens de referência e o prompt.

Propriedades

prompt string (Obrigatório)O prompt de texto. Ele descreve os elementos e as características visuais desejados no vídeo gerado.Há suporte para chinês e inglês. Cada caractere chinês ou letra conta como um caractere. A codificação de caracteres é UTF-8. Os caracteres excedentes são truncados automaticamente.
  • pixverse/pixverse-v6-r2v: até 2.048 caracteres.
Instruções de referência a imagens: ao passar uma imagem de referência no parâmetro media, você pode referenciá-la diretamente no prompt usando @ref_name.
  • O ref_name definido em media deve ser globalmente exclusivo na mesma solicitação e deve corresponder um a um às referências no prompt.
  • Regra de formatação: deixe um espaço após @ref_name como separador.
Exemplos:
  • Prompt simples: um homem está sentado em uma cadeira junto à janela, segurando um violão e tocando uma canção folk country americana relaxante ao lado de um café.
  • Prompt com referências: @man está sentado em uma cadeira junto à janela, segurando @guitar , tocando uma canção folk country americana relaxante ao lado de @coffeeshop .
media array (Obrigatório)Uma lista de recursos de mídia que especifica as imagens de referência necessárias para a geração do vídeo.Cada elemento do array é um objeto de mídia que contém os campos type e url.

Propriedades do elemento

type string (Obrigatório)O tipo do recurso de mídia. Valor fixo:
  • image_url: Uma URL de imagem.
Limite de quantidade de recursos: até 7 imagens.url string (Obrigatório)A URL da imagem de referência. A URL deve ser acessível publicamente.Restrições da imagem:
  • Formato: JPG, PNG ou WEBP.
  • Resolução: a largura e a altura da imagem não podem exceder 10.000 pixels.
  • Tamanho do arquivo: até 20 MB.
ref_name string (Opcional)O identificador de nome do sujeito na imagem de referência. É usado para referenciar a imagem no prompt com @ref_name. Até 30 caracteres.
parameters object (Obrigatório)Os parâmetros de geração de vídeo, como a resolução, a duração e se o vídeo terá áudio.

Propriedades

size string (Obrigatório)A resolução do vídeo gerado, no formato width*height, em pixels.A tabela a seguir lista os valores válidos para diferentes faixas de resolução.

Modelo pixverse/pixverse-v6-r2v

Faixa de resolução

Proporção

Valor de size (largura*altura)

360P

16:9

640*360

4:3

640*480

1:1

640*640

3:4

480*640

9:16

360*640

3:2

640*432

2:3

432*640

21:9

640*288

540P

16:9

1024*576

4:3

1024*768

1:1

1024*1024

3:4

768*1024

9:16

576*1024

3:2

1024*688

2:3

688*1024

21:9

1024*448

720P

16:9

1280*720

4:3

1108*832

1:1

960*960

3:4

832*1108

9:16

720*1280

3:2

1200*800

2:3

800*1200

21:9

1280*560

1080P

16:9

1920*1080

4:3

1664*1248

1:1

1440*1440

3:4

1248*1664

9:16

1080*1920

3:2

1776*1184

2:3

1184*1776

21:9

1920*832

Exemplo: 1280*720.duration integer (Obrigatório)
O parâmetro duration afeta diretamente o custo. Antes de fazer a chamada, confira os preços de PixVerse - vídeo com referência.
A duração do vídeo gerado, em segundos.
  • pixverse/pixverse-v6-r2v: um número inteiro no intervalo [1, 15].
Exemplo: 5.audio boolean (Opcional)
O parâmetro audio afeta diretamente o custo. Antes de fazer a chamada, confira os preços de PixVerse - vídeo com referência.
Especifica se será gerado um vídeo com áudio. Se ativado, o modelo gera automaticamente música de fundo ou efeitos sonoros correspondentes ao conteúdo do vídeo.
  • false: Valor padrão. Gera um vídeo sem som.
  • true: Gera um vídeo com áudio.
Exemplo: false.watermark boolean (Opcional)Especifica se uma marca-d’água será adicionada. Ela fica no canto inferior direito do vídeo e exibe o texto fixo "AI Generated".
  • false: Valor padrão. Nenhuma marca-d’água é adicionada.
  • true: Uma marca-d’água é adicionada.
Exemplo: false.seed integer (Opcional)A semente aleatória deve ser um número inteiro no intervalo [0, 2147483647].Se não for especificada, uma semente aleatória será gerada. Uma semente fixa melhora a reprodutibilidade.Como a geração do modelo é probabilística, a mesma semente não garante resultados idênticos.
  • Vídeo com referência
  • Python SDK
  • Vídeo com referência (usando ref_name)
Passe as imagens de referência em media e defina size e duration para controlar a resolução e a duração do vídeo.
# Replace {WorkspaceId} with your actual workspace ID.
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/aigc/video-generation/video-synthesis' \
    -H 'X-DashScope-Async: enable' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "model": "pixverse/pixverse-v6-r2v",
    "input": {
        "media": [
            {
                "type": "image_url",
                "url": "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20260320/knsple/wan-r2v-role-frame.jpg"
            },
            {
                "type": "image_url",
                "url": "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20260129/qpzxps/wan-r2v-object4.png"
            },
            {
                "type": "image_url",
                "url": "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20260129/wfjikw/wan-r2v-backgroud5.png"
            }
        ],
        "prompt": "A man sits on a chair by the window, holding a guitar, playing a soothing American country folk song next to a coffee shop"
    },
    "parameters": {
        "size": "1280*720",
        "duration": 5,
        "audio": false,
        "watermark": true
    }
}'

Parâmetros de resposta

output objectInformações de saída da tarefa.

Propriedades

task_id stringO ID da tarefa. Válido para consultas por 24 horas.task_status stringO status da tarefa.

Valores de enumeração

  • PENDING: a tarefa está na fila.
  • RUNNING: a tarefa está em processamento.
  • SUCCEEDED: a tarefa foi concluída com sucesso.
  • FAILED: a tarefa falhou.
  • CANCELED: a tarefa foi cancelada.
  • UNKNOWN: a tarefa não existe ou seu status é desconhecido.
request_id stringIdentificador exclusivo da solicitação para rastreamento e solução de problemas.code stringCódigo de erro. Retornado apenas para solicitações com falha. Consulte Códigos de erro.message stringMensagem de erro detalhada. Retornada apenas para solicitações com falha. Consulte Códigos de erro.
  • Resposta de sucesso
  • Resposta de erro
Salve o task_id para consultar o status e o resultado da tarefa.
{
    "output": {
        "task_status": "PENDING",
        "task_id": "0385dc79-5ff8-4d82-bcb6-xxxxxx"
    },
    "request_id": "4909100c-7b5a-9f92-bfe5-xxxxxx"
}

Etapa 2: consultar o resultado pelo ID da tarefa

Região de Singapura: GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/tasks/{task_id}
  • Recomendação de consulta periódica: A geração do vídeo pode levar vários minutos. Use um mecanismo de consulta periódica e consulte o resultado em intervalos razoáveis, por exemplo, a cada 15 segundos.
  • Fluxo de status da tarefa: PENDING (na fila) → RUNNING (em processamento) → SUCCEEDED (sucesso) / FAILED (falha).
  • Validade do ID da tarefa: O task_id é válido por 24 horas. Após esse período, as consultas falham e a API retorna o status de tarefa UNKNOWN.
  • Limite de RPS: O endpoint de consulta tem limite padrão de 20 RPS. Para consultas frequentes ou notificações de eventos, configure callbacks de tarefas assíncronas.
  • Outras operações: Para consultas em lote, cancelamento de tarefas e outras operações, consulte Gerenciar tarefas assíncronas.

Parâmetros de solicitação

Cabeçalhos
Authorization string (Obrigatório)Autentica a solicitação com uma chave de API do Model Studio. Exemplo: Bearer sk-xxxx.
Parâmetros de caminho
task_id string (Obrigatório)O ID da tarefa.
  • Consultar resultado da tarefa
Substitua {task_id} pelo valor de task_id retornado pela chamada de API anterior. O task_id é válido para consultas por 24 horas. Substitua {WorkspaceId} pelo seu ID do workspace real.
curl -X GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/tasks/{task_id} \
--header "Authorization: Bearer $DASHSCOPE_API_KEY"

Parâmetros de resposta

output objectInformações de saída da tarefa.

Propriedades

task_id stringO ID da tarefa. Válido para consultas por 24 horas.task_status stringO status da tarefa.

Valores de enumeração

  • PENDING: a tarefa está na fila.
  • RUNNING: a tarefa está em processamento.
  • SUCCEEDED: a tarefa foi concluída com sucesso.
  • FAILED: a tarefa falhou.
  • CANCELED: a tarefa foi cancelada.
  • UNKNOWN: a tarefa não existe ou seu status é desconhecido.
Transições de status durante as consultas periódicas:
  • PENDING (na fila) → RUNNING (em processamento) → SUCCEEDED (sucesso) / FAILED (falha).
  • O status da consulta inicial geralmente é PENDING (na fila) ou RUNNING (em processamento).
  • Quando o status muda para SUCCEEDED, a resposta contém a URL do vídeo gerado.
  • Se o status for FAILED, verifique a mensagem de erro e tente novamente.
  • Se o status for CANCELED, a tarefa foi cancelada. Para continuar, envie a tarefa novamente.
  • Se o status for UNKNOWN, a tarefa não existe ou seu status é desconhecido. Isso pode ocorrer se o task_id não existir ou tiver ultrapassado o período de validade de 24 horas.
submit_time stringO horário de envio da tarefa. Formato: YYYY-MM-DD HH:mm:ss.SSS.scheduled_time stringO horário de execução da tarefa. Formato: YYYY-MM-DD HH:mm:ss.SSS.end_time stringO horário de conclusão da tarefa. Formato: YYYY-MM-DD HH:mm:ss.SSS.video_url stringA URL do vídeo. Retornada somente quando task_status é SUCCEEDED.O vídeo está no formato MP4 (codificação H.264). No momento, o link do vídeo não expira, mas não dependa dele para armazenamento de longo prazo. Baixe o vídeo o quanto antes.orig_prompt stringO prompt de entrada original, correspondente ao parâmetro de solicitação prompt.code stringCódigo de erro. Retornado apenas para solicitações com falha. Consulte Códigos de erro.message stringMensagem de erro detalhada. Retornada apenas para solicitações com falha. Consulte Códigos de erro.
usage objectEstatísticas de uso de saída, contabilizadas apenas para tarefas bem-sucedidas.

Propriedades

duration integerA duração total do vídeo gerado, usada para faturamento.size stringA resolução do vídeo gerado.fps integerA taxa de quadros do vídeo gerado.SR stringA faixa de resolução do vídeo gerado.audio booleanIndica se o vídeo gerado tem áudio.video_count integerO número de vídeos gerados. O valor é fixo em 1.
request_id stringIdentificador exclusivo da solicitação para rastreamento e solução de problemas.
  • Tarefa bem-sucedida
  • Falha na tarefa
  • Consulta da tarefa expirada
{
    "request_id": "35137489-2862-96cb-b6f2-xxxxxx",
    "output": {
        "task_id": "1469cfc3-3004-4d9e-ab10-xxxxxx",
        "task_status": "SUCCEEDED",
        "submit_time": "2026-03-10 15:03:25.848",
        "scheduled_time": "2026-03-10 15:03:25.884",
        "end_time": "2026-03-10 15:04:05.882",
        "orig_prompt": "A man sits on a chair by the window, holding a guitar, playing a soothing American country folk song next to a coffee shop",
        "video_url": "https://media.pixverseai.cn/xxxx.mp4"
    },
    "usage": {
        "duration": 5,
        "size": "1280*720",
        "fps": 24,
        "video_count": 1,
        "audio": false,
        "SR": "720"
    }
}

Códigos de erro

Se a chamada ao modelo falhar e retornar uma mensagem de erro, consulte Códigos de erro para resolver o problema.

Perguntas frequentes

P: Como otimizar o resultado se o prompt não funcionar bem?

R: Tente usar @ref_name como alternativa.
  • Método padrão: use o prompt diretamente. O modelo analisa automaticamente o conteúdo das imagens de referência de forma global, o que funciona para a maioria dos cenários comuns.
  • Método alternativo: se o resultado gerado não corresponder ao esperado, use @ref_name para especificar a imagem de referência no prompt e melhorar o resultado.

P: Como usar ref_name?

R: ref_name cria um vínculo entre uma imagem de referência e o prompt. Depois de definir ref_name para uma imagem no array media, você pode referenciar o sujeito correspondente da imagem de referência no prompt usando a sintaxe @ref_name.
  • Por exemplo, se você definir "ref_name": "kitten" em media, use @kitten no prompt para referenciar esse sujeito. Observação: deixe um espaço após @kitten.
  • Exemplo: @kitten e @puppy estão brincando na grama.