Skip to main content

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

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

Escopo

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

Solicitação HTTP

  • Singapore
  • EUA (Virgínia)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/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-acting/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 de Mundo criptografado Acting sob a conta primária atual. Retornado por Criar Mundo.

Parâmetros de resposta

Query succeeded
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "name": "Late-Night Video Call",
        "status": "ready",
        "mode": 3,
        "creationModel": "simple",
        "prompt": "During a late-night video call, a quiet girl smiles back at the camera",
        "eventStyle": "first_frame",
        "perspective": null,
        "uploadMode": "first_frame",
        "resolution": "480p",
        "aspectRatio": "9:16",
        "layout": null,
        "narrative": null,
        "refWorldId": null,
        "firstFrameImage": {
            "url": "https://cdn.happyoyster.com/frames/portrait-call.jpg",
            "referenceType": "default"
        },
        "inputImages": null,
        "sceneImage": null,
        "roleImage": null,
        "scenePrompt": null,
        "rolePrompt": null,
        "scriptList": null,
        "previewUrl": null,
        "createdAt": "2026-09-09T08:00:00Z",
        "updatedAt": "2026-09-09T08: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 3 para Acting.creationModel stringSempre simple para Acting.prompt stringO prompt de nível superior enviado na criação.eventStyle stringUm campo de retorno de compatibilidade; quando uma criação compatível omite este campo, o servidor geralmente o mapeia a partir de uploadMode e ecoa first_frame. Não é um parâmetro de criação Acting, e os clientes não devem enviá-lo de volta.perspective nullActing não aceita um parâmetro de criação de perspectiva; fixado em null.uploadMode stringFixado em first_frame.resolution string480p / 720p; 480p se não for passado na criação.aspectRatio string9:16 / 16:9; 9:16 se não for passado na criação.layout nullActing não aceita este parâmetro de criação; fixado em null.narrative nullActing não aceita este parâmetro de criação; fixado em null.refWorldId stringO ID do Mundo de referência criptografado Acting 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, base64 não é retornado. Contém url e referenceType.inputImages nullActing atualmente não utiliza este campo.sceneImage nullActing não usa os slots de imagem de cena/personagem; fixado em null.roleImage nullActing não usa os slots de imagem de cena/personagem; fixado em null.scenePrompt nullActing não usa prompts de cena/personagem; fixado em null.rolePrompt nullActing não usa prompts de cena/personagem; fixado em null.scriptList nullActing 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.
  • eventStyle geralmente tem o mesmo valor que uploadMode; os clientes devem tratar uploadMode como o campo autoritativo para o modo de criação Acting.
  • O player pode pré-ler aspectRatio, mas ao entrar efetivamente na sala, ele ainda deve definir a orientação a partir do valor de resposta de Entrar na Viagem.
  • 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