Skip to main content

HappyOyster-Acting-Query World Detail API Reference

Interroger les métadonnées complètes et les paramètres de création renvoyables d'un seul World Acting. Pour le sondage de la progression de la construction, utiliser le point de terminaison Query World Build Status.

Scope

Interroger les métadonnées complètes et les paramètres de création renvoyables d'un seul World Acting. Avant d'appeler, confirmer 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).
  • Prérequis : Interroger avec l'encryptedWorldId retourné 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
  • États-Unis (Virginie)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/worlds/detailRemplacez {WorkspaceId} par votre véritable ID d'espace de travail.

Paramètres de la requête

  • Interroger le détail du World
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 (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 chiffré de World Acting sous le compte principal actuel. Retourné par Create World.

Paramètres de réponse

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 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 3 pour Acting.creationModel stringToujours simple pour Acting.prompt stringLe prompt de niveau supérieur soumis lors de la création.eventStyle stringUn champ de retour de compatibilité ; lorsqu'une création conforme omet ce champ, le serveur le mappe généralement depuis uploadMode et renvoie first_frame. Ce n'est pas un paramètre de création Acting et les clients ne doivent pas le renvoyer.perspective nullActing n'accepte pas de paramètre de création de perspective ; fixé à null.uploadMode stringFixé à first_frame.resolution string480p / 720p ; 480p si non transmis lors de la création.aspectRatio string9:16 / 16:9 ; 9:16 si non transmis lors de la création.layout nullActing n'accepte pas ce paramètre de création ; fixé à null.narrative nullActing n'accepte pas ce paramètre de création ; fixé à null.refWorldId stringL'ID chiffré du World de référence Acting utilisé pour une création dérivée ; null si none.firstFrameImage objectL'image de première frame requise lors de la création ; retournée uniquement sous forme d'URL, le base64 n'est pas retourné. Contient url et referenceType.inputImages nullActing n'utilise pas actuellement ce champ.sceneImage nullActing n'utilise pas les emplacements d'image de scène/rôle ; fixé à null.roleImage nullActing n'utilise pas les emplacements d'image de scène/rôle ; fixé à null.scenePrompt nullActing n'utilise pas les prompts de scène/rôle ; fixé à null.rolePrompt nullActing n'utilise pas les prompts de scène/rôle ; fixé à null.scriptList nullActing 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, ready ou failed ; certains artefacts de construction peuvent être null avant 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é.
  • eventStyle a généralement la même valeur que uploadMode ; les clients doivent considérer uploadMode comme le champ faisant autorité pour le mode de création Acting.
  • Le lecteur peut pré-lire aspectRatio, mais lors de l'entrée effective dans la salle, il doit tout de même définir l'orientation à partir de la valeur de réponse Enter Travel.
  • 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