Alibaba Cloud Model Studio:HappyOyster-Adventure-Query Travel Artifacts API Reference

Query the recorded original and the three composited variants of a completed Adventure Travel. For external delivery, withInstructionAndWatermark is recommended.

Scope

Query the recorded original and the three composited variants of a completed Adventure Travel. In Adventure, withInstruction means the exploration-interaction overlay variant, not a text-instruction subtitle variant. For external delivery, withInstructionAndWatermark is recommended. Before calling, confirm the following:

• Authentication: Only the primary API Key is supported; temporary API Keys cannot be used (error code 403003).

  • Get the primary API Key: Get and configure an API Key.

• Prerequisites: The Travel status is completed. An available original URL is the precondition for returning an artifacts response. Confirm via Query Travel Status.

• Caller: Called by your server.

HTTP request

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"

{
    "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": 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": 90
            },
            "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
            }
        }
    }
}

Prerequisite states and call notes

• When the Travel is not completed, does not exist, does not belong to you or is not Adventure, or the original is not yet available, 404000 is returned; the original is the hard gate for the whole endpoint.
• The client can poll at a controlled interval while composeStatus != ready.
• Do not interpret withInstruction as a directing text subtitle; in Adventure it is the exploration-interaction overlay.
• For external delivery, read video.withInstructionAndWatermark; if your business only needs the original, keep reading video.original.url.
• The four video variants share the same duration-parsing result, so within one response the ready variants with a parseable duration return a consistent durationSec.
• A Travel ended by TRAVEL_NO_STREAM_AUTO_END is failed and generates no queryable artifacts.

Error codes

If the model call fails and returns an error, see HappyOyster Error Codes to resolve it.

Next steps

• Query Travel List: view other historical Travels.
• End Travel: end a new Travel before querying its artifacts.