Référence de l'API HappyOyster-Acting-Query Travel Artifacts - Alibaba Cloud Model Studio

Interroger l'enregistrement original et les trois variantes composites d'un Travel Acting terminé. Pour une diffusion externe, withInstructionAndWatermark est recommandé.

Scope

Interroger l'enregistrement original et les trois variantes composites d'un Travel Acting terminé. withInstruction est la variante superposée des instructions de processus de l'utilisateur ; pour une diffusion externe, withInstructionAndWatermark est recommandé. Avant d'effectuer l'appel, confirmez les points suivants :

Authentification : Seule la clé API principale est prise en charge ; les clés API temporaires ne peuvent pas être utilisées (code d'erreur 403003).
- Obtenir la clé API principale : Obtenir et configurer une clé API.
Prérequis : Le statut du Travel doit être completed. Une URL originale disponible est la condition préalable au renvoi d'une réponse d'artefacts. Confirmez ce statut via Query Travel Status.
Appelant : Appelé par votre serveur.

Requête HTTP

Singapore

GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/artifacts

Remplacez {WorkspaceId} par votre véritable ID d'espace de travail.

États-Unis (Virginie)

GET https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/artifacts

Remplacez {WorkspaceId} par votre véritable ID d'espace de travail.

Paramètres de la requête	Interroger les artefacts du Travel `curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/artifacts?encryptedTravelId={encryptedTravelId}' \ -H "Authorization: Bearer $DASHSCOPE_API_KEY"`
Authorization `string` (Requis) Authentification par clé API. Seule la clé API principale est prise en charge ; elle commence par `sk-`, par ex. `sk-xxx`. Elle est généralement configurée comme variable d'environnement `$DASHSCOPE_API_KEY`. Une clé API temporaire (commençant par `st-`) renvoie `403003`.
Paramètres de requête
encryptedTravelId `string` (Obligatoire) Un ID de Travel chiffré Acting avec le statut `completed`. Renvoyé par Enter Travel.

Paramètres de réponse

Quatre artefacts prêts

{
    "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
            }
        }
    }
}

Composition en cours

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "composeStatus": "processing",
        "video": {
            "original": {
                "url": "https://cdn.happyoyster.com/exports/trvl_a1b2c3d4e5f6_raw.mp4?v=2",
                "status": "ready",
                "resolution": "720p",
                "durationSec": 180
            },
            "withWatermark": {
                "url": null,
                "status": "processing",
                "resolution": null,
                "durationSec": null
            },
            "withInstruction": {
                "url": null,
                "status": "processing",
                "resolution": null,
                "durationSec": null
            },
            "withInstructionAndWatermark": {
                "url": null,
                "status": "processing",
                "resolution": null,
                "durationSec": null
            }
        }
    }
}

code integer

Code de retour. 0 indique un succès ; une valeur non nulle correspond à un code d'erreur.

message string

Message d'erreur. null en cas de succès.

data object

Données de réponse. null en cas d'échec.

Propriétés

encryptedTravelId string

Identifiant de voyage chiffré.

composeStatus string

Le statut agrégé des trois variantes composées :

ready : withWatermark, withInstruction et withInstructionAndWatermark sont tous ready
partial : au moins une variante composée est ready, mais pas toutes
processing : none des trois variantes composées n'est pas ready

Il agrège uniquement les trois variantes composées et n'inclut pas original.

video object

Les quatre variantes fixes de la vidéo principale. Chaque élément contient url, status, resolution et durationSec.

original : l'original enregistré ; une représentation 720p est retournée de préférence lorsqu'elle est disponible
withWatermark : variante composée avec filigrane uniquement
withInstruction : variante composée avec la superposition d'instruction de processus de l'utilisateur
withInstructionAndWatermark : variante composée avec superposition d'instruction de processus de l'utilisateur + filigrane, recommandée pour la diffusion externe

video.*.url string

URL de téléchargement ; null lorsque processing ou unavailable.

video.*.status string

Statut par élément :

ready : prêt, url est accessible
processing : composition en cours, url=null
unavailable : la composition a échoué ou l'URL est temporairement indisponible, url=null

video.*.resolution string

"720p" lorsque original correspond à 720p ; sinon cela peut être null.

video.*.durationSec integer

La durée vidéo analysée uniformément en secondes ; lorsqu'elle est analysable, toutes les variantes ready portent cette valeur. Elle peut être null lorsque l'état est processing / unavailable ou lorsque la durée ne peut pas encore être analysée.

États préalables et notes d'appel

Le client peut interroger à un intervalle contrôlé tant que composeStatus != ready.
video.withInstruction est la variante avec superposition d'instruction de processus, et non l'original sans instruction.
Pour une diffusion externe, consultez video.withInstructionAndWatermark ; si votre activité nécessite uniquement l'original, continuez à lire video.original.url.
Les quatre variantes vidéo partagent le même résultat d'analyse de durée, donc dans une même réponse, les variantes prêtes dont la durée est analysable renvoient une valeur durationSec cohérente.
Un voyage terminé par TRAVEL_NO_STREAM_AUTO_END est failed et ne génère aucun artefact interrogeable.
Ne considérez pas toujours 404000 comme « pas encore terminé » : lisez d'abord status et errorCode via Query Travel Status ou Query Travel List ; pour un Travel failed, affichez la raison de l'échec.

Scénarios 404000

Scénario	Comportement du point de terminaison
Le Travel est toujours en cours (`init` / `pending` / `running` / `paused`)	Renvoie le code métier `404000`, avec `message` = `Video is still being generated, please try again once the process is complete`
Le Travel est `failed`	Renvoie le code métier `404000`, avec `message` = `Experience failed and no video was produced (errorCode=<errorCode>): <errorMessage>`; l'échec est définitif et aucune vidéo ne sera produite
Le Travel n'existe pas, ne vous appartient pas ou n'est pas de type Acting	Renvoie le code métier `404000`
L'URL originale n'est pas disponible	Renvoie le code métier `404000`; l'original constitue la condition stricte pour l'ensemble du point de terminaison
L'original est prêt et la composition est toujours en cours	HTTP 200 ; l'élément composite correspondant a `status=processing`, `url=null`
Échec de la composition ou URL temporairement indisponible	HTTP 200 ; l'élément composite correspondant a `status=unavailable`, `url=null`

Codes d'erreur

Si l'appel du modèle échoue et renvoie une erreur, consultez Codes d'erreur HappyOyster pour la résoudre.

Étapes suivantes

Query Travel List : consulter d'autres voyages historiques.
End Travel : terminer un nouveau voyage avant d'interroger ses artefacts.