## Retrieve `models.description.retrieve(strmodel_id, DescriptionRetrieveParams**kwargs) -> DescriptionRetrieveResponse` **get** `/models/{modelId}/description` Get the description of the given `modelId` ### Parameters - `model_id: str` - `original_assets: Optional[bool]` If set to true, returns the original asset without transformation ### Returns - `class DescriptionRetrieveResponse: …` - `description: Description` - `assets: List[DescriptionAsset]` The list of assets referenced by the Markdown `{asset}` tag in the description. - `id: str` The asset ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw") - `author_id: str` The author user ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea") - `kind: Literal["3d", "audio", "document", 4 more]` The kind of asset - `"3d"` - `"audio"` - `"document"` - `"image"` - `"image-hdr"` - `"json"` - `"video"` - `mime_type: str` The mime type of the asset (example: "image/png") - `owner_id: str` The owner (project) ID (example: "proj_23tlk332lkht3kl2" or "team_dlkhgs23tlk3hlkth32lkht3kl2" for old teams) - `privacy: Literal["private", "public", "unlisted"]` The privacy of the asset - `"private"` - `"public"` - `"unlisted"` - `properties: DescriptionAssetProperties` The properties of the asset, content may depend on the kind of asset returned - `size: float` - `animation_frame_count: Optional[float]` Number of animation frames if animations exist - `bitrate: Optional[float]` Bitrate of the media in bits per second - `bone_count: Optional[float]` Number of bones if skeleton exists - `channels: Optional[float]` Number of channels of the audio - `classification: Optional[Literal["effect", "interview", "music", 5 more]]` Classification of the audio - `"effect"` - `"interview"` - `"music"` - `"other"` - `"sound"` - `"speech"` - `"text"` - `"unknown"` - `codec_name: Optional[str]` Codec name of the media - `description: Optional[str]` Description of the audio - `dimensions: Optional[List[float]]` Bounding box dimensions [width, height, depth] - `duration: Optional[float]` Duration of the media in seconds - `face_count: Optional[float]` Number of faces/triangles in the mesh - `format: Optional[str]` Format of the mesh file (e.g. 'glb', etc.) - `frame_rate: Optional[float]` Frame rate of the video in frames per second - `has_animations: Optional[bool]` Whether the mesh has animations - `has_normals: Optional[bool]` Whether the mesh has normal vectors - `has_skeleton: Optional[bool]` Whether the mesh has bones/skeleton - `has_u_vs: Optional[bool]` Whether the mesh has UV coordinates - `height: Optional[float]` - `nb_frames: Optional[float]` Number of frames in the video - `sample_rate: Optional[float]` Sample rate of the media in Hz - `transcription: Optional[DescriptionAssetPropertiesTranscription]` Transcription of the audio - `text: str` - `vertex_count: Optional[float]` Number of vertices in the mesh - `width: Optional[float]` - `source: Literal["3d23d", "3d23d:texture", "3d:texture", 72 more]` source of the asset - `"3d23d"` - `"3d23d:texture"` - `"3d:texture"` - `"3d:texture:albedo"` - `"3d:texture:metallic"` - `"3d:texture:mtl"` - `"3d:texture:normal"` - `"3d:texture:roughness"` - `"audio2audio"` - `"audio2video"` - `"background-removal"` - `"canvas"` - `"canvas-drawing"` - `"canvas-export"` - `"detection"` - `"generative-fill"` - `"image-prompt-editing"` - `"img23d"` - `"img2img"` - `"img2video"` - `"inference-control-net"` - `"inference-control-net-img"` - `"inference-control-net-inpainting"` - `"inference-control-net-inpainting-ip-adapter"` - `"inference-control-net-ip-adapter"` - `"inference-control-net-reference"` - `"inference-control-net-texture"` - `"inference-img"` - `"inference-img-ip-adapter"` - `"inference-img-texture"` - `"inference-in-paint"` - `"inference-in-paint-ip-adapter"` - `"inference-reference"` - `"inference-reference-texture"` - `"inference-txt"` - `"inference-txt-ip-adapter"` - `"inference-txt-texture"` - `"patch"` - `"pixelization"` - `"reframe"` - `"restyle"` - `"segment"` - `"segmentation-image"` - `"segmentation-mask"` - `"skybox-3d"` - `"skybox-base-360"` - `"skybox-hdri"` - `"texture"` - `"texture:albedo"` - `"texture:ao"` - `"texture:edge"` - `"texture:height"` - `"texture:metallic"` - `"texture:normal"` - `"texture:smoothness"` - `"txt23d"` - `"txt2audio"` - `"txt2img"` - `"txt2video"` - `"unknown"` - `"uploaded"` - `"uploaded-3d"` - `"uploaded-audio"` - `"uploaded-avatar"` - `"uploaded-video"` - `"upscale"` - `"upscale-skybox"` - `"upscale-texture"` - `"upscale-video"` - `"vectorization"` - `"video23d"` - `"video2audio"` - `"video2img"` - `"video2video"` - `"voice-clone"` - `url: str` Signed URL to get the asset content - `original_file_url: Optional[str]` The original file url. Contains the url of the original file. without any conversion. Only available for some specific video, audio and threeD assets. Is only specified if the given asset data has been replaced with a new file during the creation of the asset. - `preview: Optional[DescriptionAssetPreview]` The asset's preview. Contains the assetId and the url of the preview. - `asset_id: str` - `url: str` - `thumbnail: Optional[DescriptionAssetThumbnail]` The asset's thumbnail. Contains the assetId and the url of the thumbnail. - `asset_id: str` - `url: str` - `models: List[DescriptionModel]` The list of models referenced by the Markdown `{model}` tag in the description. - `id: str` The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w") - `privacy: Literal["private", "public", "unlisted"]` The privacy of the model (default: private) - `"private"` - `"public"` - `"unlisted"` - `type: Literal["custom", "elevenlabs-voice", "flux.1", 34 more]` The model type (example: "flux.1-lora") - `"custom"` - `"elevenlabs-voice"` - `"flux.1"` - `"flux.1-composition"` - `"flux.1-kontext-dev"` - `"flux.1-kontext-lora"` - `"flux.1-krea-dev"` - `"flux.1-krea-lora"` - `"flux.1-lora"` - `"flux.1-pro"` - `"flux.1.1-pro-ultra"` - `"flux.2-dev-edit-lora"` - `"flux.2-dev-lora"` - `"flux.2-klein-4b-edit-lora"` - `"flux.2-klein-4b-lora"` - `"flux.2-klein-9b-edit-lora"` - `"flux.2-klein-9b-lora"` - `"flux.2-klein-base-4b-edit-lora"` - `"flux.2-klein-base-4b-lora"` - `"flux.2-klein-base-9b-edit-lora"` - `"flux.2-klein-base-9b-lora"` - `"flux1.1-pro"` - `"gpt-image-1"` - `"qwen-image-2512-lora"` - `"qwen-image-edit-2509-lora"` - `"qwen-image-edit-2511-lora"` - `"qwen-image-edit-lora"` - `"qwen-image-lora"` - `"sd-1_5"` - `"sd-1_5-composition"` - `"sd-1_5-lora"` - `"sd-xl"` - `"sd-xl-composition"` - `"sd-xl-lora"` - `"zimage-de-turbo-lora"` - `"zimage-lora"` - `"zimage-turbo-lora"` - `author_id: Optional[str]` The author user ID (example: "user_VFhihHKMRZyDDnZAJwLb2Q") - `name: Optional[str]` The model name (example: "Cinematic Realism") - `owner_id: Optional[str]` The owner ID (example: "team_VFhihHKMRZyDDnZAJwLb2Q") - `short_description: Optional[str]` The model short description (example: "This model generates highly detailed cinematic scenes.") - `value: str` The markdown description of the model (ex: `# My model`). We allow the `{asset:}` and `{model:}` tags. ### Example ```python import os from scenario_sdk import Scenario client = Scenario( api_key=os.environ.get("SCENARIO_SDK_API_KEY"), # This is the default and can be omitted api_secret=os.environ.get("SCENARIO_SDK_API_SECRET"), # This is the default and can be omitted ) description = client.models.description.retrieve( model_id="modelId", ) print(description.description) ``` #### Response ```json { "description": { "assets": [ { "id": "id", "authorId": "authorId", "kind": "3d", "mimeType": "mimeType", "ownerId": "ownerId", "privacy": "private", "properties": { "size": 0, "animationFrameCount": 0, "bitrate": 0, "boneCount": 0, "channels": 0, "classification": "effect", "codecName": "codecName", "description": "description", "dimensions": [ 0, 0, 0 ], "duration": 0, "faceCount": 0, "format": "format", "frameRate": 0, "hasAnimations": true, "hasNormals": true, "hasSkeleton": true, "hasUVs": true, "height": 0, "nbFrames": 0, "sampleRate": 0, "transcription": { "text": "text" }, "vertexCount": 0, "width": 0 }, "source": "3d23d", "url": "url", "originalFileUrl": "originalFileUrl", "preview": { "assetId": "assetId", "url": "url" }, "thumbnail": { "assetId": "assetId", "url": "url" } } ], "models": [ { "id": "id", "privacy": "private", "type": "custom", "authorId": "authorId", "name": "name", "ownerId": "ownerId", "shortDescription": "shortDescription" } ], "value": "value" } } ```