Skip to main content

Referência da API HappyOyster-Directing-Query Travel Artifacts

Consulte o original gravado e as três variantes compostas de uma Viagem de Direção concluída. Um original disponível é a pré-condição para retornar uma resposta de artefatos; para entrega externa, withInstructionAndWatermark é recomendado.

Escopo

Consulte o original gravado e as três variantes compostas de uma Viagem de Direção concluída. Um original disponível é a pré-condição para retornar uma resposta de artefatos; as variantes compostas ainda podem estar em processamento. Para entrega externa, withInstructionAndWatermark é recomendado. Antes de chamar, confirme o seguinte:
  • Autenticação: Apenas a API Key primária é suportada; API Keys temporárias não podem ser usadas (código de erro 403003).
  • Pré-requisitos: O status da Viagem é completed. Um original disponível é a pré-condição para retornar uma resposta de artefatos. Confirme via Consultar Status da Viagem.
  • Caller: Chamado pelo seu servidor.

Solicitação HTTP

  • Singapore
  • EUA (Virgínia)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/artifactsSubstitua {WorkspaceId} pelo seu ID do Workspace real.

Parâmetros da solicitação

  • Consultar artefatos da Viagem
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/artifacts?encryptedTravelId={encryptedTravelId}' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY"
Authorization string (Obrigatório)Autenticação por API Key. Apenas a API Key primária é suportada; ela começa com sk-, ex. sk-xxx. É tipicamente configurada como a variável de ambiente $DASHSCOPE_API_KEY. Uma API Key temporária (começando com st-) retorna 403003.
Parâmetros de consulta
encryptedTravelId string (Obrigatório)Um ID de Viagem criptografado de Direção com status completed. Retornado por Entrar na Viagem.

Parâmetros de resposta

  • Todos os quatro artefatos prontos
  • Composição ainda em processamento
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "composeStatus": "ready",
        "video": {
            "original": {
                "url": "https://cdn.happyoyster.com/exports/trvl_a1b2c3d4e5f6_raw.mp4?v=2",
                "status": "ready",
                "resolution": "720p",
                "durationSec": 180
            },
            "withWatermark": {
                "url": "https://cdn.happyoyster.com/exports/trvl_a1b2c3d4e5f6_wm.mp4?v=2",
                "status": "ready",
                "resolution": null,
                "durationSec": 180
            },
            "withInstruction": {
                "url": "https://cdn.happyoyster.com/exports/trvl_a1b2c3d4e5f6_overlay.mp4?v=2",
                "status": "ready",
                "resolution": null,
                "durationSec": 180
            },
            "withInstructionAndWatermark": {
                "url": "https://cdn.happyoyster.com/exports/trvl_a1b2c3d4e5f6_all.mp4?v=2",
                "status": "ready",
                "resolution": null,
                "durationSec": 180
            }
        }
    }
}
code integerCódigo de retorno. 0 indica sucesso; diferente de zero é um código de erro.
message stringMensagem de erro. null em caso de sucesso.
data objectDados da resposta. null em caso de falha.

Propriedades

encryptedTravelId stringTravel ID criptografado.composeStatus stringO status agregado das três variantes compostas:
  • ready: withWatermark, withInstruction e withInstructionAndWatermark estão todos ready
  • partial: pelo menos uma variante composta está ready, mas não todas
  • processing: none das três variantes compostas está ready
Ele agrega apenas as três variantes compostas e não inclui original.video objectOs quatro artefatos de vídeo da linha principal, com uma estrutura de campos fixa. Cada item contém url, status, resolution e durationSec.
  • original: o original gravado; uma representação de 720p é preferida
  • withWatermark: variante composta apenas com marca d'água
  • withInstruction: variante composta apenas com legendas de instrução do usuário
  • withInstructionAndWatermark: variante composta com legendas de instrução do usuário e marca d'água, recomendada para entrega externa
video.*.url stringURL do vídeo; null quando status=processing.video.*.status stringStatus por item:
  • ready: o vídeo está pronto e a URL está acessível
  • processing: ainda processando; url é null
  • unavailable: a composição falhou ou a URL está temporariamente indisponível
video.*.resolution stringvideo.original.resolution é "720p" quando o original corresponde a 720p; caso contrário, é null.video.*.durationSec integerA duração do vídeo uniformemente analisada em segundos; quando analisável, todas as variantes ready carregam este valor. Pode ser null quando processing / unavailable ou quando a duração ainda não pode ser analisada.

Estados pré-requisitos e notas de chamada

  • Quando a Viagem não é completed, não existe, não pertence a você ou não é de Direção, ou o original não está disponível, 404000 é retornado; um original disponível é a pré-condição para retornar uma resposta de artefatos.
  • Quando você precisar de todas as variantes compostas, pode continuar consultando enquanto composeStatus != ready.
  • video.withInstructionAndWatermark é a variante recomendada para entrega externa.
  • As quatro variantes de vídeo compartilham o mesmo resultado de análise de duração, portanto, dentro de uma única resposta, as variantes prontas com duração analisável retornam um durationSec consistente.

Códigos de erro

Se a chamada do modelo falhar e retornar um erro, consulte Códigos de Erro do HappyOyster para resolvê-lo.

Próximos passos