Skip to main content

Référence de l'API HappyOyster-Directing-Query Travel Artifacts

Interroger l'enregistrement original et les trois variantes composées d'un voyage de mise en scène terminé. Un original disponible est la condition préalable pour retourner une réponse d'artefacts ; pour la diffusion externe, withInstructionAndWatermark est recommandé.

Scope

Interroger l'enregistrement original et les trois variantes composées d'un voyage de mise en scène terminé. Un original disponible est la condition préalable pour retourner une réponse d'artefacts ; les variantes composées peuvent encore être en cours de traitement. Pour la diffusion externe, withInstructionAndWatermark est recommandé. Avant d'effectuer l'appel, confirmer 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).
  • Prérequis : Le statut du voyage est completed. Un original disponible est la condition préalable pour retourner une réponse d'artefacts. Confirmer via Interroger le statut du voyage.
  • Appelant : Appelé par votre serveur.

Requête HTTP

  • Singapore
  • États-Unis (Virginie)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/artifactsRemplacez {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-directing/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 voyage chiffré de mise en scène avec le statut completed. Retourné par Entrer dans le voyage.

Paramètres de réponse

  • Quatre artefacts prêts
  • Composition en cours
{
    "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 integerCode de retour. 0 indique un succès ; une valeur non nulle correspond à un code d'erreur.
message stringMessage d'erreur. null en cas de succès.
data objectDonnées de réponse. null en cas d'échec.

Propriétés

encryptedTravelId stringIdentifiant de voyage chiffré.composeStatus stringLe 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 objectLes quatre artefacts vidéo principaux, avec une structure de champs fixe. Chaque élément contient url, status, resolution et durationSec.
  • original : l'enregistrement original ; une représentation 720p est préférée
  • withWatermark : variante composée avec filigrane uniquement
  • withInstruction : variante composée avec uniquement les sous-titres d'instructions utilisateur
  • withInstructionAndWatermark : variante composée avec sous-titres d'instructions utilisateur et filigrane, recommandée pour la diffusion externe
video.*.url stringURL de la vidéo ; null lorsque status=processing.video.*.status stringStatut par élément :
  • ready : la vidéo est prête et l'URL est accessible
  • processing : traitement en cours ; url est null
  • unavailable : la composition a échoué ou l'URL est temporairement indisponible
video.*.resolution stringvideo.original.resolution est "720p" lorsque l'original correspond à 720p ; sinon il est null.video.*.durationSec integerLa 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

  • Lorsque le voyage n'est pas completed, n'existe pas, ne vous appartient pas ou n'est pas de type mise en scène, ou que l'original n'est pas disponible, 404000 est retourné ; un original disponible est la condition préalable pour retourner une réponse d'artefacts.
  • Lorsque vous avez besoin de toutes les variantes composées, vous pouvez continuer à interroger tant que composeStatus != ready.
  • video.withInstructionAndWatermark est la variante recommandée pour la diffusion externe.
  • 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.

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.