Référence de l'API HappyOyster-Directing-Query World Build Status - Alibaba Cloud Model Studio

Interroger la progression de la construction d'un Monde Directing. L'API retourne l'ID de Monde chiffré, le statut de construction et l'URL de la première image ; le client effectue un polling jusqu'à ce que le Monde passe à l'état ready.

Scope

Interroger la progression de la construction d'un Monde Directing. Avant d'appeler, confirmez les points suivants :

Authentification : La primary API Key n'est pas requise ; soit la clé API principale, soit une clé API temporaire peut appeler ce point de terminaison. Pour savoir comment les obtenir, voir Obtain authentication credentials.
Prérequis : Interroger avec l'encryptedWorldId retourné par Create World. Vous pouvez commencer à interroger à partir de l'état generating.
Appelant : Votre serveur ou votre client peut l'appeler.

Requête HTTP

Singapore

GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/build-status

Remplacez {WorkspaceId} par votre véritable ID d'espace de travail.

États-Unis (Virginie)

GET https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/build-status

Remplacez {WorkspaceId} par votre véritable ID d'espace de travail.

Paramètres de la requête	Interroger le statut de construction du World `curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/build-status?encryptedWorldId={encryptedWorldId}' \ -H "Authorization: Bearer $DASHSCOPE_API_KEY"`
Authorization `string` (Requis) Authentification par clé API. La clé API principale n'est pas requise ; la clé principale ou une clé API temporaire peut l'appeler. Clé API principale : commence par `sk-`, par ex. `sk-xxx`. Clé API temporaire : commence par `st-`, par exemple `st-xxx`.
Paramètres de requête
encryptedWorldId `string` (Requis) L'ID de Monde chiffré Directing retourné par Créer un monde.

Paramètres de réponse

Construction en cours

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "status": "generating",
        "firstFrame": null
    }
}

Construction terminée

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "status": "ready",
        "firstFrame": "https://cdn.happyoyster.com/frames/world_xyz789.jpg",
        "name": "Midnight Visitor",
        "mode": 2
    }
}

code integer

Code de retour. 0 indique un succès ; une valeur non nulle correspond à un code d'erreur.

message string

Message d'erreur. null en cas de succès.

data object

Données de réponse. null en cas d'échec.

Propriétés

encryptedWorldId string

ID chiffré du World.

status string

Statut de la construction : generating / ready / failed.

firstFrame string

URL de la première image du World ; null lorsqu'elle n'est pas encore générée ou lorsque la construction a échoué.

name string

Nom du World. Retourné uniquement lorsque status=ready.

mode integer

Toujours 2 pour Directing. Retourné uniquement lorsque status=ready.

États préalables et notes d'appel

Sonder toutes les 3–5 secondes jusqu'à ce que status soit ready ou failed.
Seul un World ready peut échanger contre un identifiant de travel et entrer dans la salle.
Lorsqu'une image URL échoue à la validation après un stockage asynchrone, le World peut passer de generating à failed.
Ce point de terminaison ne retourne pas aspectRatio.

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

Une fois que le World passe à l'état ready :

Get Travel Credential : échanger contre un ticket à usage unique.
Interroger les détails du Monde : interroger toutes les métadonnées de création.