Referencia de la API HappyOyster-Directing-Query World Build Status - Alibaba Cloud Model Studio

Consulte el progreso de construcción de un World de Directing. La API devuelve el ID de World cifrado, el estado de construcción y la URL del primer fotograma; el cliente sondea hasta que el World entra en estado ready.

Ámbito

Consulte el progreso de construcción de un World de Directing. Antes de llamar, confirme lo siguiente:

Autenticación: La clave API principal no es obligatoria; este endpoint puede invocarse con la clave principal o con una clave API temporal. Para saber cómo obtenerlas, consulte Obtener credenciales de autenticación.
Requisitos previos: Consulte con el encryptedWorldId devuelto por Create World. Puede comenzar a consultar desde el estado generating.
Solicitante: Puede invocarla su servidor o su cliente.

Solicitud HTTP

Singapore

GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/build-status

Reemplace {WorkspaceId} con su ID de espacio de trabajo real.

EE. UU. (Virginia)

GET https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/build-status

Reemplace {WorkspaceId} con su ID de espacio de trabajo real.

Parámetros de solicitud	Consultar estado de construcción de World `curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/build-status?encryptedWorldId={encryptedWorldId}' \ -H "Authorization: Bearer $DASHSCOPE_API_KEY"`
Authorization `string` (Requerido) Autenticación mediante clave de API. No se requiere la clave de API principal; pueden invocarla tanto la clave principal como una temporal. Clave de API principal: comienza con `sk-`, por ejemplo, `sk-xxx`. Clave de API temporal: comienza con `st-`, por ejemplo, `st-xxx`.
Parámetros de consulta
encryptedWorldId `string` (Requerido) El ID de World cifrado de Directing devuelto por Create World.

Parámetros de respuesta

En construcción

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "status": "generating",
        "firstFrame": null
    }
}

Construcción completada

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "status": "ready",
        "firstFrame": "https://cdn.happyoyster.com/frames/world_xyz789.jpg",
        "name": "Midnight Visitor",
        "mode": 2
    }
}

code integer

Código de retorno. 0 indica éxito; un valor distinto de cero es un código de error.

message string

Mensaje de error. null en caso de éxito.

data object

Datos de respuesta. null en caso de fallo.

Propiedades

encryptedWorldId string

ID de World cifrado.

status string

Estado de construcción: generating / ready / failed.

firstFrame string

URL del primer fotograma del World; null cuando aún no se ha generado o cuando la construcción falló.

name string

Nombre del World. Se devuelve solo cuando status=ready.

mode integer

Siempre 2 para Directing. Se devuelve solo cuando status=ready.

Estados previos y notas de llamada

Sondee cada 3–5 segundos hasta que status sea ready o failed.
Solo un World en estado ready puede canjearse por una credencial de travel y entrar a la sala.
Cuando una imagen de URL falla la validación tras el almacenamiento asíncrono, el World puede pasar de generating a failed.
Este endpoint no devuelve aspectRatio.

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

Después de que el World entra en ready:

Obtener credencial de Travel: canjear por un ticket de un solo uso.
Consultar detalles del mundo: consultar los metadatos completos de la creación.