Skip to main content

Referencia de la API HappyOyster-Acting-Query World List

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

Ámbito

Paginar a través de los Acting Worlds 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
  • EE. UU. (Virginia)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/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-acting/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 Acting, y items[].mode siempre es 3. Si aún así lo pasa y el valor no es 3, se devuelve 400000.

Parámetros de respuesta

Query succeeded
{
    "code": 0,
    "message": null,
    "data": {
        "items": [
            {
                "encryptedWorldId": "enc_a1b2****",
                "name": "Late-Night Video Call",
                "status": "ready",
                "mode": 3,
                "previewUrl": null,
                "createdAt": "2026-09-09T08:00:00Z",
                "perspective": null,
                "creationModel": "simple",
                "uploadMode": "first_frame"
            },
            {
                "encryptedWorldId": "enc_g7h8****",
                "name": "Relaxed Living Room Chat",
                "status": "ready",
                "mode": 3,
                "previewUrl": null,
                "createdAt": "2026-09-09T09:00:00Z",
                "perspective": null,
                "creationModel": "simple",
                "uploadMode": "first_frame"
            }
        ],
        "pagination": {
            "page": 1,
            "pageSize": 20,
            "total": 2,
            "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 mundos en la página actual; una matriz vacía cuando no hay resultados. Cada elemento contiene encryptedWorldId, name, status (generating / ready / failed), mode (siempre 3), previewUrl (generalmente null), createdAt, perspective (generalmente null), creationModel (siempre simple) y uploadMode (fijo en first_frame).pagination objectInformación de paginación. Contiene page (número de página actual), pageSize (elementos reales por página), total (número total de registros) y hasMore (true cuando page × pageSize < total).

Estados previos y notas de llamada

  • El filtrado por modelo entra en vigor automáticamente; la lista nunca mezcla mundos de otros modelos, y items[].mode siempre es 3.
  • Los elementos de la lista son instantáneas ligeras; no devuelven imágenes, prompts, resolution, aspectRatio ni refWorldId. Cuando necesite la configuración completa, llame a Consulta de detalles del mundo.
  • 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