Skip to main content

Referência da API HappyOyster-Adventure-Query World Detail

Consultar os metadados completos e os parâmetros de criação replicáveis de um único Mundo Adventure. Para sondagem de progresso de construção, use o endpoint Consultar Status de Construção do Mundo.

Escopo

Consultar os metadados completos e os parâmetros de criação replicáveis de um único Mundo Adventure. Antes de chamar, confirme o seguinte:

Solicitação HTTP

  • Singapore
  • China (Pequim)
  • EUA (Virgínia)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/worlds/detailSubstitua {WorkspaceId} pelo seu ID do Workspace real.

Parâmetros da solicitação

  • Consultar detalhes do Mundo
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 (Obrigatório)Autenticação por API Key. Apenas a API Key primária é suportada; ela começa com sk-, ex. sk-xxx. É tipicamente configurada como a variável de ambiente $DASHSCOPE_API_KEY. Uma API Key temporária (começando com st-) retorna 403003.
Parâmetros de consulta
encryptedWorldId string (Obrigatório)Um ID criptografado de Mundo Adventure na conta principal atual. Retornado por Criar Mundo.

Parâmetros de resposta

  • Consulta bem-sucedida
{
    "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 sucesso; diferente de zero é um código de erro.
message stringMensagem de erro. null em caso de sucesso.
data objectDados da resposta. null em caso de falha.

Propriedades

encryptedWorldId stringID do Mundo criptografado.name stringNome do Mundo.status stringStatus da construção: generating / ready / failed.mode integerSempre 1 para Adventure.creationModel stringSempre simple para Adventure.prompt stringO prompt de nível superior enviado na criação.eventStyle nullO Adventure não utiliza este parâmetro de criação; tipicamente null. Este campo só tem efeito para Directing creationModel=simple.perspective stringPerspectiva: first_person / third_person.uploadMode stringFixado em first_frame.resolution nullO Adventure não utiliza este campo; geralmente null.aspectRatio nullO Adventure não utiliza este campo; fixado em null.layout nullO Adventure não utiliza este campo; geralmente null.narrative nullO Adventure não utiliza este campo; geralmente null.refWorldId stringO ID criptografado do Mundo de referência usado para uma criação derivada; null se none.firstFrameImage objectA imagem obrigatória do primeiro quadro na criação; retornada apenas em formato de URL. Contém url e referenceType.inputImages nullO Adventure não utiliza este campo atualmente.scriptList nullO Adventure não suporta ScriptList; fixado em null.previewUrl nullAtualmente fixado em null.createdAt stringHora de criação, no formato ISO 8601.updatedAt stringÚltima hora de atualização, no formato ISO 8601.

Estados pré-requisitos e notas de chamada

  • Este endpoint pode consultar um Mundo generating, ready ou failed; alguns artefatos de construção podem ser null antes de estarem prontos.
  • O endpoint de detalhes não ecoa async, pois é uma opção de comportamento de chamada, não um atributo do Mundo.
  • As imagens são retornadas apenas como URL e referenceType; o conteúdo base64 na solicitação de criação não é retornado.
  • Consultar um Mundo de outro modelo, de outra conta principal ou que tenha sido excluído retorna 403001, sem revelar se o recurso existe.

Códigos de erro

Se a chamada do modelo falhar e retornar um erro, consulte Códigos de Erro do HappyOyster para resolvê-lo.

Próximos passos