Skip to main content

Referencia de la API de HappyOyster-Directing-Query Travel Artifacts

Consulta el original grabado y las tres variantes compuestas de un Viaje de Dirección completado. Un original disponible es la condición previa para devolver una respuesta de artefactos; para entrega externa, se recomienda withInstructionAndWatermark.

Ámbito

Consulta el original grabado y las tres variantes compuestas de un Viaje de Dirección completado. Un original disponible es la condición previa para devolver una respuesta de artefactos; las variantes compuestas pueden estar aún en proceso. Para entrega externa, se recomienda withInstructionAndWatermark. Antes de realizar la llamada, confirme lo siguiente:
  • Autenticación: Solo se admite la API Key principal; no se pueden utilizar API Keys temporales (código de error 403003).
  • Requisitos previos: El estado del Viaje es completed. Un original disponible es la condición previa para devolver una respuesta de artefactos. Confírmelo mediante Consultar estado del viaje.
  • Caller: Llamado por su servidor.

Solicitud HTTP

  • Singapore
  • EE. UU. (Virginia)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/artifactsReemplace {WorkspaceId} con su ID de espacio de trabajo real.

Parámetros de solicitud

  • Consultar artefactos del Travel
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 (Requerido)Autenticación mediante API Key. Solo se admite la API Key principal; comienza con sk-, p. ej., sk-xxx. Normalmente se configura como la variable de entorno $DASHSCOPE_API_KEY. Una API Key temporal (que comienza con st-) devuelve 403003.
Parámetros de consulta
encryptedTravelId string (Obligatorio)Un ID de Viaje cifrado de Dirección con estado completed. Devuelto por Entrar al viaje.

Parámetros de respuesta

  • Los cuatro artefactos están listos
  • Composición aún en proceso
{
    "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 éxito; un valor distinto de cero es un código de error.
message stringMensaje de error. null en caso de éxito.
data objectDatos de respuesta. null en caso de fallo.

Propiedades

encryptedTravelId stringID de viaje cifrado.composeStatus stringEl estado agregado de las tres variantes compuestas:
  • ready: withWatermark, withInstruction y withInstructionAndWatermark están todos en ready
  • partial: al menos una variante compuesta está en ready, pero no todas
  • processing: none de las tres variantes compuestas está en ready
Agrega únicamente las tres variantes compuestas y no incluye original.video objectLos cuatro artefactos de video principales, con una estructura de campos fija. Cada elemento contiene url, status, resolution y durationSec.
  • original: el original grabado; se prefiere una representación de 720p
  • withWatermark: variante compuesta solo con marca de agua
  • withInstruction: variante compuesta solo con subtítulos de instrucciones del usuario
  • withInstructionAndWatermark: variante compuesta con subtítulos de instrucciones del usuario y marca de agua, recomendada para entrega externa
video.*.url stringURL del video; null cuando status=processing.video.*.status stringEstado por elemento:
  • ready: el video está listo y la URL es accesible
  • processing: aún procesando; url es null
  • unavailable: la composición falló o la URL no está disponible temporalmente
video.*.resolution stringvideo.original.resolution es "720p" cuando el original coincide con 720p; de lo contrario, es null.video.*.durationSec integerLa duración del video analizada uniformemente en segundos; cuando es analizable, todas las variantes ready incluyen este valor. Puede ser null cuando está en processing / unavailable o cuando la duración aún no se puede analizar.

Estados previos y notas de llamada

  • Cuando el Viaje no es completed, no existe, no le pertenece o no es de Dirección, o el original no está disponible, se devuelve 404000; un original disponible es la condición previa para devolver una respuesta de artefactos.
  • Cuando necesite todas las variantes compuestas, puede seguir sondeando mientras composeStatus != ready.
  • video.withInstructionAndWatermark es la variante recomendada para entrega externa.
  • Las cuatro variantes de video comparten el mismo resultado de análisis de duración, por lo que dentro de una misma respuesta las variantes listas con una duración analizable devuelven un valor consistente de durationSec.

Códigos de error

Si la llamada al modelo falla y devuelve un error, consulte Códigos de error de HappyOyster para resolverlo.

Siguientes pasos