Transform your first Vehicle

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 tonull**.

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.