Skip to main content
QwenCloud home page
Docs
Acting (Invitational Preview)

HappyOyster-Acting-Query Travel Artifacts API Reference

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

GET
/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/artifacts
cURL - Query Travel artifacts
# Singapore (ap-southeast-1). For another region, replace ap-southeast-1 in the URL.
# API keys are region-specific. See https://docs.qwencloud.com/developer-guides/getting-started/regions
curl --location 'https://ap-southeast-1.maas.qwencloudapi.com/api/v2/apps/happyoyster-1.0-acting/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": 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
      }
    }
  }
}

Scope

withInstruction is the overlay variant of the user's process instructions; 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).
  • Prerequisites: The Travel status is completed. Confirm via Query Travel Status.
  • Caller: Called by your server.
If the model call fails and returns an error, see HappyOyster Error Codes to resolve it.

Authorizations

​
string
header
required

QwenCloud API Key. Only the primary API Key (sk- prefix) is supported. See Get an API Key.

Header Parameters

​
string
required

API Key authentication. Only the primary API Key is supported; it starts with sk-, e.g. sk-xxx. It is typically configured as the environment variable $DASHSCOPE_API_KEY. A temporary API Key (starting with st-) returns 403003.

Query Parameters

​
string
required

An Acting encrypted Travel ID with status completed. Returned by Enter Travel (Client).

Response

200-application/json
​
integer

Return code. 0 means success; non-zero is an error code.

​
string | null

Error message. null on success.

​
object

Response data. null on failure.