Analyze a product photo (save as product)
vivid_analyze_productAnalyzes a product photo to extract attributes and create a clean e-commerce render, saving it as a reusable PRODUCT you can feature by name in image generation.
Instructions
Analyze a product photo: vision analysis (name, category, colors, material, finish, style, keywords) + a clean e-commerce render, saved to the account as a PRODUCT you can then feature by name in vivid_generate_image products (see vivid_list_references). Costs 10 credits (refunded if the analysis fails) and counts toward the plan's monthly analysis quota. Takes 30–90 s; waits by default. For jewelry the geometry lock may ask the app to confirm the category; the name comes from the analysis (rename in the app if needed).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| wait | No | ||
| image | No | Product photo: absolute local path (preferred — uploaded as multipart) or URL (JPEG/PNG/WebP, max 15 MB; some CDNs such as Pexels refuse server-side downloads → use a local path). URLs from vivid_upload_file work too. | |
| jobId | No | Resume waiting on an analysis that returned status "processing" (no new analysis, no quota). | |
| locale | No | Language of the generated name/description. | it |
| assetId | No | Analyze a photo already in the VIVID gallery (asset id from vivid_list_assets) instead of `image`. | |
| timeoutSec | No | ||
| description | No | What the product is, to help the analysis (e.g. "silver bracelet with blue pearls"). |