Transform your first Vehicle
Send us vehicle images and/or video, and Spyne will return transformed outputs.
Create a request
method: post
endpoint: https://api.spyne.ai/api/pv1/merchandise/process/
What it does:
- Accepts vehicle identifiers, raw media files, product info and processing config
- Applies AI to produce transformed studio-grade images, 360 spin, or feature video
- Returns a
dealerVinIdon success request.
Example Payload:
{
"vin": "<VIN of the vehicle>",
"stockNumber": "<Your internal stock number>",
"registrationNumber": "<Registration number of the vehicle>",
"media": {
"image": true,
"spin": true,
"featureVideo": true
},
"mediaInput": {
"imageData": [
{
"url": "https://uploads.vw-mms.de/system/production/images/vwn/024/594/images/717c166910bd27376186f6428dbde9575050769f/DB2018AU00327_web_1600.jpg?1649153661"
},
{
"url": " https://uploads.vw-mms.de/system/production/images/vwn/024/594/images/717c166910bd27376186f6428dbde9575050769f/DB2018AU00327_web_1600.jpg?1649153661"
},
{
"url": " https://uploads.vw-mms.de/system/production/images/vwn/024/594/images/717c166910bd27376186f6428dbde9575050769f/DB2018AU00327_web_1600.jpg?1649153661"
},
{
"url": " https://uploads.vw-mms.de/system/production/images/vwn/024/594/images/717c166910bd27376186f6428dbde9575050769f/DB2018AU00327_web_1600.jpg?1649153661"
},
{
"url": " https://uploads.vw-mms.de/system/production/images/vwn/024/594/images/717c166910bd27376186f6428dbde9575050769f/DB2018AU00327_web_1600.jpg?1649153661"
},
{
"url": " https://uploads.vw-mms.de/system/production/images/vwn/024/594/images/717c166910bd27376186f6428dbde9575050769f/DB2018AU00327_web_1600.jpg?1649153661"
},
{
"url": " https://uploads.vw-mms.de/system/production/images/vwn/024/594/images/717c166910bd27376186f6428dbde9575050769f/DB2018AU00327_web_1600.jpg?1649153661"
},
{
"url": " https://uploads.vw-mms.de/system/production/images/vwn/024/594/images/717c166910bd27376186f6428dbde9575050769f/DB2018AU00327_web_1600.jpg?1649153661"
}
]
},
"processingDetails": {
"backgroundId": "20883",
"bannerId": "1",
"numberPlateLogo": "1",
"catalog": {
"backgroundType": "legacy",
"extractCatalogCount": "8"
},
"spin": {
"hotspot": true,
"spinFrameCount": "72"
},
"featureVideo": {
"templateId": "6758566c41fa6398621c9563",
"musicId": "66a8e815200257e9dcff1c90",
"voiceId": "voice-f22ad31e7bc84888bb96fa8b4db35cd8"
},
}
}
Understanding the payload
Below is a detailed explanation of each parameter, its significance, and how to use it effectively.
| Parameter | Category | Description |
|---|---|---|
| vin stockNumber registrationNumber | Vehicle Unique Identifier | A unique Vehicle Identification Number that is used to identify the vehicle being processed. Note: Provide the vehicle's VIN, or alternatively, use stockNumber or registrationNumber. |
| dealerId | Rooftop of the Dealership | Identifies the specific dealership or rooftop submitting the request. This is also known as Team ID in the spyne's system. Note: This is an optional field and the vehicle will be processed within the default dealer/team if the Dealer ID is not provided. |
| media | Products to be generated | This Specifies the types of media to process. image: Transforms raw images to studio images. spin: Created a studio 360-spin of the vehicle. featureVideo: Create a feature video. How to Use: Use true or false for each option. If a value is not passed, it defaults to null. |
| mediaInput | Input Media to be processed | The mediaInput parameter contains the media URLs of the vehicle, either images, videos, or both. 1. Image URLs (imageData): An array of raw image URLs of the vehicle. 2. Video URLs (videoData): An array of raw video URLs of the vehicle.Key Note: It is not always necessary to provide a video URL to generate a 360-spin. If you provide 6 exterior images of a vehicle, the system can also create a smooth and seamless 360-spin.Priority: Videos are prioritized for 360° spin generation and Images are prioritized for catalog processing or as an alternative source for spins when video is not available. |
| processingDetails | Processing Details Parameters - Common Configurations | This key is required if you have opted for one or both products: Images / 360 spin. If you have only opted for feature video, this key is not required. backgroundId: Specifies the background for processed media. Provide the unique background ID that is shared with you by the Spyne Team. numberPlateLogo Customizes the vehicle’s number plate. Pass 0 for no masking, Pass 1 for white masking, or Provide a URL for a custom logo or image. bannerId: Adds a banner to the processed output. Provide the unique banner ID that is maintained by the Spyne team. catalog: extractCatalogCount: Defines the number of images to be extracted from the input video. This parameter is only needed if the input media is a video and you want us to extract images from the video. To be sent if the image processing is set to true. backgroundType: Specifies the background style for catalog images. If no parameter is provided, it defaults to "legacy". spin: spinFrameCount: Sets the number of frames in the 360-spin. Provide an integer value (e.g., 36 or 72). Higher number results in a smoother spin. hotspot: Indicates whether hotspots (interactive elements) are added to the spin. Use true to enable or false to disable hotspots. The hotspots will be generated by AI. featureVideo: templateId: Chooses the template for the feature video. Provide the unique template ID provided by the Spyne team. musicId: Adds background music to the video. Provide the unique music ID provided by Spyne team. voiceId: Adds a voice-over to the video. Provide the unique voice ID provided by Spyne team. |
Retrieve Transformed media
Use your dealerVinId provided in the above request to get the transformed media.
method: get
path: /merchandise
Setup webhook endpoint to directly receive the transformed media
Updated about 2 months ago