Skip to main content

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

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

Scope

Interroger l'enregistrement original et les trois variantes composites d'un Travel Adventure terminé. Dans Adventure, withInstruction signifie la variante avec superposition d'exploration-interaction, et non une variante de sous-titre d'instruction textuelle. Pour la diffusion externe, withInstructionAndWatermark est recommandé. Avant d'appeler, 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).
  • 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
  • Chine (Pékin)
  • États-Unis (Virginie)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/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-adventure/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 chiffré de Travel Adventure avec le statut completed. Retourné par Entrer dans le Travel.

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": 90
            },
            "withWatermark": {
                "url": "https://cdn.happyoyster.com/exports/trvl_a1b2c3d4e5f6_wm.mp4?v=2",
                "status": "ready",
                "resolution": null,
                "durationSec": 90
            },
            "withInstruction": {
                "url": "https://cdn.happyoyster.com/exports/trvl_a1b2c3d4e5f6_overlay.mp4?v=2",
                "status": "ready",
                "resolution": null,
                "durationSec": 90
            },
            "withInstructionAndWatermark": {
                "url": "https://cdn.happyoyster.com/exports/trvl_a1b2c3d4e5f6_all.mp4?v=2",
                "status": "ready",
                "resolution": null,
                "durationSec": 90
            }
        }
    }
}
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 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 composite avec superposition d'exploration-interaction uniquement (pas une variante de sous-titre d'instruction textuelle)
  • withInstructionAndWatermark : variante composite avec superposition d'exploration-interaction + filigrane, recommandée pour la diffusion externe
video.*.url stringURL de téléchargement ; null lorsque processing ou unavailable.video.*.status stringStatut 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 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 Travel n'est pas completed, n'existe pas, ne vous appartient pas ou n'est pas Adventure, ou que l'original n'est pas encore disponible, 404000 est retourné ; l'original est la condition stricte pour l'ensemble du point de terminaison.
  • Le client peut interroger à un intervalle contrôlé tant que composeStatus != ready.
  • N'interprétez pas withInstruction comme un sous-titre de texte de mise en scène ; dans Adventure, il s'agit de la superposition d'exploration-interaction.
  • 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.

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.