Skip to main content

Referencia de la API de consulta de detalles de World de HappyOyster-Adventure

Consulta los metadatos completos y los parámetros de creación reproducibles de un único World de Adventure. Para el sondeo del progreso de construcción, utilice el endpoint Query World Build Status.

Ámbito

Consulta los metadatos completos y los parámetros de creación reproducibles de un único World de Adventure. Antes de realizar la llamada, confirme lo siguiente:

Solicitud HTTP

  • Singapore
  • China (Beijing)
  • EE. UU. (Virginia)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/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-adventure/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 Adventure bajo la cuenta principal actual. Devuelto por Create World.

Parámetros de respuesta

  • Consulta exitosa
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "name": "Rainy Night Adventure in Jiangnan",
        "status": "ready",
        "mode": 1,
        "creationModel": "simple",
        "prompt": "A Jiangnan water town at dusk, with stone bridges and awning boats",
        "eventStyle": null,
        "perspective": "third_person",
        "uploadMode": "first_frame",
        "resolution": null,
        "aspectRatio": null,
        "layout": null,
        "narrative": null,
        "refWorldId": null,
        "firstFrameImage": {
            "url": "https://cdn.happyoyster.com/frames/jiangnan.jpg",
            "referenceType": "default"
        },
        "inputImages": null,
        "sceneImage": null,
        "roleImage": null,
        "scenePrompt": null,
        "rolePrompt": null,
        "scriptList": null,
        "previewUrl": 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 1 para Adventure.creationModel stringSiempre simple para Adventure.prompt stringEl prompt de nivel superior enviado durante la creación.eventStyle nullAdventure no utiliza este parámetro de creación; típicamente es null. Este campo solo tiene efecto para Directing creationModel=simple.perspective stringPerspectiva: first_person / third_person.uploadMode stringFijo en first_frame.resolution nullAdventure no utiliza este campo; usualmente es null.aspectRatio nullAdventure no utiliza este campo; fijado en null.layout nullAdventure no utiliza este campo; usualmente es null.narrative nullAdventure no utiliza este campo; usualmente es null.refWorldId stringEl ID de World de referencia cifrado utilizado para una creación derivada; null si no hay none.firstFrameImage objectLa imagen del primer fotograma requerida en la creación; se devuelve solo en formato URL. Contiene url y referenceType.inputImages nullAdventure no utiliza actualmente este campo.scriptList nullAdventure no admite ScriptList; fijado en null.previewUrl nullActualmente fijo en null.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; algunos artefactos de construcción pueden ser null antes de estar listos.
  • El endpoint de detalle no refleja async, porque es un modificador de comportamiento de llamada, no un atributo del World.
  • Las imágenes se devuelven solo como URL y referenceType; el contenido base64 de la solicitud de creación no se devuelve.
  • 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