Consulte o status atual, os parâmetros de criação e as informações retornáveis do ScriptList de um único Mundo do Directing. Para polling de progresso de construção, use o endpoint Query World Build Status.
Escopo
Consulte o status atual, os parâmetros de criação e as informações retornáveis do ScriptList de um único Mundo do Directing. Antes de chamar, confirme o seguinte:
-
Autenticação: Apenas a API Key primária é suportada; API Keys temporárias não podem ser usadas (código de erro
403003).- Obtenha a API Key primária: Obter e configurar uma API Key.
-
Pré-requisitos: Consulte com o
encryptedWorldIdretornado por Criar Mundo. Para sondagem de progresso de construção, use Consultar Status de Construção do Mundo. - Caller: Chamado pelo seu servidor.
Solicitação HTTP
- Singapore
- EUA (Virgínia)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/detailSubstitua {WorkspaceId} pelo seu ID do Workspace real.Parâmetros da solicitação |
|
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 do Directing na conta principal atual. Retornado por Criar Mundo. |
Parâmetros de resposta |
|
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 2 para Direção.creationModel stringsimple / scriptlist; determina quais endpoints de controle a Viagem pode chamar.prompt stringO Prompt usado ao criar no modo simple; fixo como null para scriptlist.eventStyle stringO estilo de evento na criação: normal / dramatic / regular.perspective nullGeralmente null para o modelo Directing.uploadMode nullGeralmente null para um Mundo do Directing.resolution string480p / 720p.layout stringO estilo de movimento de câmera para o modo simple; geralmente null quando não passado ou para scriptlist.narrative stringO estilo narrativo para o modo simple; geralmente null quando não passado ou para scriptlist.refWorldId stringO ID de Mundo de referência criptografado usado para uma criação derivada.firstFrameImage objectA imagem do primeiro quadro na criação; base64 não é retornado na resposta.inputImages arrayAs imagens de referência persistidas ao criar no modo simple; scriptlist não aceita este campo, portanto, geralmente é null.scriptList objectTem valor apenas para um Mundo scriptlist; null quando a análise do script estruturado falha. Contém synopsis, videoTitle, scene, style, speed, language, setting, soundtrack, prologue, videoTags, subjects (com label/name/type/refImage, etc.) e acts (retornado integralmente de acordo com o conteúdo armazenado, com turn/content/cameraType/shotSize/cut).previewUrl nullAtualmente fixado em null.aspectRatio nullFixado como null para o modelo de Direção.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,readyoufailed. - Ele não ecoa o campo
asyncda solicitação de criação. - Os campos de imagem retornam apenas URL e
referenceType, e nunca retornam base64. OsinputImagespara o modosimplesão persistidos como imagens de referência e podem ser retornados nos detalhes;scriptlistnão aceita este campo. - Quando
scriptListé analisado normalmente, a estrutura completa armazenada é retornada, eactsé retornado integralmente de acordo com o conteúdo armazenado; quando a análise falha,scriptList=nullé retornado, e umactsvazio não é usado para indicar uma falha de análise. - 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
- Consultar Lista de Mundos: paginar por todos os Mundos do Directing.
- Excluir Mundo: exclua um Mundo que você não utiliza mais.
- Quando o Mundo está
ready, você pode Obter Credencial de Viagem.