Interroger les métadonnées complètes et les paramètres de création répercutables d'un seul Adventure World. Pour l'interrogation de la progression de la construction, utilisez le point de terminaison Query World Build Status.
Scope
Interroger les métadonnées complètes et les paramètres de création répercutables d'un seul Adventure World. Avant d'appeler, confirmez les points suivants :
-
Authentification : Seule la clé API principale est prise en charge ; les clés API temporaires ne peuvent pas être utilisées (code d'erreur
403003).- Obtenir la clé API principale : Obtenir et configurer une clé API.
-
Prérequis : Interroger avec l'
encryptedWorldIdretourné par Create World. Pour le sondage de la progression de la construction, utiliser Query World Build Status. - Appelant : Appelé par votre serveur.
Requête HTTP
- Singapore
- Chine (Pékin)
- États-Unis (Virginie)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/worlds/detailRemplacez {WorkspaceId} par votre véritable ID d'espace de travail.Paramètres de la requête |
|
Authorization string (Requis)Authentification par clé API. Seule la clé API principale est prise en charge ; elle commence par sk-, par ex. sk-xxx. Elle est généralement configurée comme variable d'environnement $DASHSCOPE_API_KEY. Une clé API temporaire (commençant par st-) renvoie 403003. | |
Paramètres de requête | |
encryptedWorldId string (Requis)Un ID de World chiffré Adventure sous le compte principal actuel. Retourné par Create World. |
Paramètres de réponse |
|
code integerCode de retour. 0 indique un succès ; une valeur non nulle correspond à un code d'erreur. | |
message stringMessage d'erreur. null en cas de succès. | |
data objectDonnées de réponse. null en cas d'échec.
Propriétés encryptedWorldId stringID chiffré du World.name stringNom du World.status stringStatut de la construction : generating / ready / failed.mode integerToujours 1 pour Adventure.creationModel stringToujours simple pour Adventure.prompt stringLe prompt de niveau supérieur soumis lors de la création.eventStyle nullAdventure n'utilise pas ce paramètre de création ; typiquement null. Ce champ ne prend effet que pour Directing creationModel=simple.perspective stringPerspective : first_person / third_person.uploadMode stringFixé à first_frame.resolution nullAdventure n'utilise pas ce champ ; généralement null.aspectRatio nullAdventure n'utilise pas ce champ ; fixé à null.layout nullAdventure n'utilise pas ce champ ; généralement null.narrative nullAdventure n'utilise pas ce champ ; généralement null.refWorldId stringL'ID de World de référence chiffré utilisé pour une création dérivée ; null si none.firstFrameImage objectL'image de première image requise lors de la création ; retournée uniquement sous forme d'URL. Contient url et referenceType.inputImages nullAdventure n'utilise pas actuellement ce champ.scriptList nullAdventure ne prend pas en charge ScriptList ; fixé à null.previewUrl nullActuellement fixé à null.createdAt stringHeure de création, au format ISO 8601.updatedAt stringHeure de dernière mise à jour, au format ISO 8601. |
États préalables et notes d'appel
- Ce point de terminaison peut interroger un World
generating,readyoufailed; certains artefacts de construction peuvent êtrenullavant d'être prêts. - Le point de terminaison de détail ne renvoie pas
async, car il s'agit d'un commutateur de comportement d'appel et non d'un attribut du World. - Les images sont retournées uniquement sous forme d'URL et de
referenceType; le contenu base64 de la requête de création n'est pas retourné. - L'interrogation d'un World provenant d'un autre modèle, d'un autre compte principal, ou d'un World supprimé retourne toujours
403001, sans révéler si la ressource existe.
Codes d'erreur
Si l'appel du modèle échoue et renvoie une erreur, consultez Codes d'erreur HappyOyster pour la résoudre.
Étapes suivantes
- Query World List : paginer tous les Adventure Worlds.
- Delete World : supprimer un World que vous n'utilisez plus.
- Lorsque le World est
ready, vous pouvez Get Travel Credential.