Skip to main content

Referencia de la API de consulta de lista de Worlds de HappyOyster-Adventure

Paginación a través de los Worlds de Adventure bajo la cuenta principal actual. El endpoint está aislado automáticamente por modelo y nunca devuelve Worlds de Directing o Acting.

Ámbito

Paginación a través de los Worlds de Adventure bajo la cuenta principal actual. Antes de realizar la llamada, confirme lo siguiente:
  • Autenticación: Solo se admite la API Key principal; no se pueden utilizar API Keys temporales (código de error 403003).
  • Caller: Llamado por su servidor.

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/worldsReemplace {WorkspaceId} con su ID de espacio de trabajo real.

Parámetros de solicitud

  • Lista de consulta de mundos
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/worlds?page=1&pageSize=20&status=ready' \
    -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
page integer (Opcional)Número de página, el valor predeterminado es 1. Cuando page <= 0, se trata como 1.
pageSize integer (Opcional)Elementos por página, el valor predeterminado es 20. Cuando pageSize <= 0, se trata como 20; cuando es mayor que 100, se limita a 100.
status string (Opcional)Filtrar por estado de construcción. Los valores desconocidos no se aplican como filtro. Valores permitidos:
  • generating: construyendo
  • ready: listo
  • failed: error de construcción
mode integer (Opcional)No es necesario pasar esto. La lista ya está filtrada al modelo Adventure, y items[].mode siempre es 1. Si aun así lo pasa y el valor no es 1, se devuelve 400000.

Parámetros de respuesta

  • Consulta exitosa
{
    "code": 0,
    "message": null,
    "data": {
        "items": [
            {
                "encryptedWorldId": "enc_a1b2****",
                "name": "Cyberpunk Detective World",
                "status": "ready",
                "mode": 1,
                "previewUrl": null,
                "createdAt": "2026-06-03T10:00:00Z",
                "perspective": "first_person",
                "creationModel": "simple",
                "uploadMode": "first_frame"
            }
        ],
        "pagination": {
            "page": 1,
            "pageSize": 20,
            "total": 1,
            "hasMore": false
        }
    }
}
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

items arrayLos Worlds en la página actual; una matriz vacía cuando no hay resultados. Cada elemento contiene encryptedWorldId, name, status (generating / ready / failed), mode (siempre 1), previewUrl (usualmente null), createdAt, perspective (first_person / third_person), creationModel (siempre simple) y uploadMode (fijado en first_frame).pagination objectInformación de paginación. Contiene page, pageSize, total y hasMore (true cuando page × pageSize < total).

Estados previos y notas de llamada

  • Los elementos de la lista son instantáneas ligeras; no devuelven imágenes, prompts, refWorldId u otros parámetros de creación completos. Cuando necesite la configuración completa, llame a Query World Detail.
  • Un valor desconocido de status no genera error; se trata como si no hubiera filtro de estado.
  • Al paginar, utilice pagination.pageSize y hasMore de la respuesta; no asuma que los valores solicitados se adoptan textualmente.
  • Un resultado vacío no constituye un error; devuelve items=[] y la información de paginación correspondiente.

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