Skip to main content

Referencia de la API HappyOyster-Directing-Query World Detail

Consulte el estado actual, los parámetros de creación y la información ScriptList retornable de un solo World de Directing. Para el sondeo del progreso de construcción, utilice el endpoint Query World Build Status.

Ámbito

Consulte el estado actual, los parámetros de creación y la información ScriptList retornable de un solo World de Directing. Antes de llamar, confirme lo siguiente:

Solicitud HTTP

  • Singapore
  • EE. UU. (Virginia)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/detailReemplace {WorkspaceId} con su ID de espacio de trabajo real.

Parámetros de solicitud

  • Consultar detalle de World
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/detail?encryptedWorldId={encryptedWorldId}' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY"
Authorization string (Requerido)Autenticación mediante API Key. Solo se admite la API Key principal; comienza con sk-, p. ej., sk-xxx. Normalmente se configura como la variable de entorno $DASHSCOPE_API_KEY. Una API Key temporal (que comienza con st-) devuelve 403003.
Parámetros de consulta
encryptedWorldId string (Requerido)Un ID de World cifrado de Directing bajo la cuenta principal actual. Devuelto por Create World.

Parámetros de respuesta

  • Consulta exitosa (modo script)
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "name": "Midnight Visitor",
        "status": "ready",
        "mode": 2,
        "creationModel": "scriptlist",
        "prompt": null,
        "eventStyle": "normal",
        "perspective": null,
        "uploadMode": null,
        "resolution": "720p",
        "layout": null,
        "narrative": null,
        "refWorldId": null,
        "firstFrameImage": {
            "url": "https://cdn.happyoyster.com/frames/room.png",
            "referenceType": "default"
        },
        "inputImages": null,
        "scriptList": {
            "synopsis": "Late at night, Su Li is startled awake by a knock at the door.",
            "videoTitle": "Midnight Visitor",
            "subjects": [
                {
                    "label": "[character_1]",
                    "name": "Su Li",
                    "type": "character",
                    "refImage": {
                        "url": "https://cdn.happyoyster.com/subjects/suli.png",
                        "referenceType": "default"
                    }
                }
            ],
            "acts": [
                {
                    "turn": 1,
                    "content": "Rain beats against the window, and [character_1] is startled awake from sleep.",
                    "cameraType": "Static",
                    "shotSize": "Wide",
                    "cut": "long-take"
                },
                {
                    "turn": 2,
                    "content": "[character_1] walks toward the door, and the knocking sounds again outside.",
                    "cameraType": "Push-in",
                    "shotSize": "Close-up",
                    "cut": "long-take"
                }
            ]
        },
        "previewUrl": null,
        "aspectRatio": null,
        "createdAt": "2026-06-03T10:00:00Z",
        "updatedAt": "2026-06-03T10:05:00Z"
    }
}
code integerCódigo de retorno. 0 indica éxito; un valor distinto de cero es un código de error.
message stringMensaje de error. null en caso de éxito.
data objectDatos de respuesta. null en caso de fallo.

Propiedades

encryptedWorldId stringID de World cifrado.name stringNombre del World.status stringEstado de construcción: generating / ready / failed.mode integerSiempre 2 para Dirección.creationModel stringsimple / scriptlist; determina qué endpoints de control puede llamar el Travel.prompt stringEl Prompt utilizado al crear en modo simple; fijo en null para scriptlist.eventStyle stringEl estilo de evento en la creación: normal / dramatic / regular.perspective nullGeneralmente null para el modelo Directing.uploadMode nullGeneralmente null para un World de Directing.resolution string480p / 720p.layout stringEl estilo de movimiento de cámara para el modo simple; generalmente null cuando no se pasa o para scriptlist.narrative stringEl estilo narrativo para el modo simple; generalmente null cuando no se pasa o para scriptlist.refWorldId stringEl ID de World de referencia cifrado utilizado para una creación derivada.firstFrameImage objectLa imagen del primer fotograma en la creación; base64 no se devuelve en la respuesta.inputImages arrayLas imágenes de referencia persistidas al crear en modo simple; scriptlist no acepta este campo, por lo que generalmente es null.scriptList objectTiene valor solo para un World scriptlist; null cuando falla el análisis del script estructurado. Contiene synopsis, videoTitle, scene, style, speed, language, setting, soundtrack, prologue, videoTags, subjects (con label/name/type/refImage, etc.) y acts (devuelto en su totalidad según el contenido almacenado, con turn/content/cameraType/shotSize/cut).previewUrl nullActualmente fijo en null.aspectRatio nullFijado en null para el modelo de Dirección.createdAt stringHora de creación, en formato ISO 8601.updatedAt stringÚltima hora de actualización, en formato ISO 8601.

Estados previos y notas de llamada

  • Este endpoint puede consultar un World en estado generating, ready o failed.
  • No refleja el campo async de la solicitud de creación.
  • Los campos de imagen devuelven solo URL y referenceType, y nunca devuelven base64. Los inputImages para el modo simple se persisten como imágenes de referencia y pueden devolverse en el detalle; scriptlist no acepta este campo.
  • Cuando scriptList se analiza correctamente, se devuelve la estructura almacenada completa, y acts se devuelve en su totalidad según el contenido almacenado; cuando falla el análisis, se devuelve scriptList=null, y no se utiliza un acts vacío para indicar un fallo de análisis.
  • Consultar un World de otro modelo, de otra cuenta principal o uno que haya sido eliminado siempre devuelve 403001, sin revelar si el recurso existe.

Códigos de error

Si la llamada al modelo falla y devuelve un error, consulte Códigos de error de HappyOyster para resolverlo.

Siguientes pasos