All Products
Search

This Product

    Alibaba Cloud Model Studio:HappyOyster-Directing-Pause Travel API Reference

    Document Center

    Alibaba Cloud Model Studio:HappyOyster-Directing-Pause Travel API Reference

    Last Updated:Sep 20, 2026

    Request to pause a running Directing Travel. After the pause completes, you can call resume or rewind.

    Scope

    Request to pause a running Directing Travel. After the pause completes, you can call resume or rewind. Before calling, confirm the following:

    • Authentication: The primary API Key is not required; either the primary or a temporary API Key can call it. For how to obtain them, see Obtain authentication credentials.
    • Prerequisites: The Travel status must be running. Confirm via Query Travel Status.
    • Caller: Either your server or your client can call it.

    HTTP request

    Singapore

    POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/pause

    Replace {WorkspaceId} with your actual Workspace ID.

    US (Virginia)

    POST https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/pause

    Replace {WorkspaceId} with your actual Workspace ID.

    Request parameters

    Pause Travel

    curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/pause' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedTravelId": "{encryptedTravelId}",
    "userAgent": "your-client/1.2.0"
}'

    Content-Typestring(Required)

    Request content type. This parameter must be set to application/json.

    Authorization string (Required)

    API Key authentication. The primary API Key is not required; either the primary or a temporary API Key can call it.

    • Primary API Key: starts with sk-, e.g. sk-xxx.
    • Temporary API Key: starts with st-, e.g. st-xxx.
    Request Body

    encryptedTravelId string (Required)

    The Directing encrypted Travel ID to pause. Returned by Enter Travel.

    userAgent string (Optional)

    SDK or client version identifier. A non-empty string; takes precedence over the HTTP User-Agent.

    Response parameters

    Pause succeeded

    {
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "status": "paused"
    }
}

    code integer

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

    message string

    Error message. null on success.

    data object

    Response data. null on failure.

    Properties

    encryptedTravelId string

    The encrypted Travel ID.

    status string

    The target pause status; returns paused.

    Prerequisite states and call notes

    • The current Travel status must be running.
    • The version in the enter-room response must be storyV2; entering the room for this model always returns this value.
    • The server-side status confirmation of pause is an asynchronous process. When you need to immediately call rewind or resume, poll Query Travel Status until the status is paused.

    Error codes

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

    Next steps

    After pausing, you can do the following: