3D 360-Spin

Accepts a publicly accessible complete-round video of a vehicle and returns a high-quality Studio 360-spin.

POSThttps://api.spyne.ai/360/v1/3d

AuthBearer token

Prefer ReadMe's own explorer? Open it here.

Request body

Parameter	Type	Required	Description
`videoUrl`	string	Optional	The URL of the video to be processed. Example: `https://spyne.s3.amazonaws.com/multipartUpload/d4b845bb5/Maya/de47221eea1c4e5a8444824cf8da4d01/4f2bb68016684225b0cfe3783b0794f7/video/9D6B40EE-B6D0-43B7-BDE2-351DC881C8DE.mp4`.
`vin_name`	string	Optional	VIN name associated with the video. Example: `5NPE34AB6FH087111`.
`backgroundId`	string	Optional	Spyne Studio-type Background ID. Example: `36242`.
`generatePhotos`	object	Optional	Generate 8-12 Exterior Photos from Video in Studio-type Backgrounds.
`generatePhotos.catalogCount`	integer	Optional	This property only accepts 8 OR 12 as an input value. Default: `8`. Example: `8`.
`exteriorFrameCount`	integer	Optional	Number of frames in the exterior spin. Example: `36`.
`interior360Image`	string	Optional	URL to the 360 interior image. Example: `https://spyne-prod-tech.s3.amazonaws.com/b7982f335/ca62c156/1a3a21e8e8e14c27a7d880f47cec1989/ec18a6194b0e4cf8a984488e7a91fa54/images/input/hres__ec18a6194b0e4cf8a984488e7a91fa54_360int_2.jpeg`.
`licensePlateUrl`	string	Optional	URL to the license plate image. Example: `https://spyne-test.s3.amazonaws.com/alm%20leasing%20%26%20rentals_18e2d9d0_2024-03-20_17-48-58%20copy.png`.
`meta_data`	object	Optional	Additional metadata associated with the request. Must be a JSON object, and users can freely add key-value strings.

Sample request

curl --request POST \
  --url 'https://api.spyne.ai/360/v1/3d' \
  --header 'Authorization: Bearer YOUR_API_KEY'

import requests

url = "https://api.spyne.ai/360/v1/3d"
headers = {"Authorization": "Bearer YOUR_API_KEY"}

response = requests.post(url, headers=headers)
print(response.status_code, response.json())

const response = await fetch("https://api.spyne.ai/360/v1/3d", {
  method: "POST",
  headers: {
    Authorization: "Bearer YOUR_API_KEY",
  },
});
console.log(response.status, await response.json());

Response parameters (200)

Field	Type	Description
`status`	string	Example: `success`.
`data`	object	Contains the resulting 360-spin data and URLs.

Errors

Status	Meaning	When it happens
`400`	Bad Request	Bad Request if any required fields are missing or incorrect
`401`	Unauthorized	Unauthorized access
`500`	Internal Server Error	Internal server error during 3D spin generation